Editing or contributing to documentation

How to contribute to the docs

I use Hugo to format and generate this website, the Docsy theme for styling and site structure, and Netlify to manage the deployment of the site. Hugo is an open-source static site generator that provides templates, a standard directory structure in which to organize content, and a website generation engine. Pages can be written in Markdown or HTML (or both if you want), and Hugo will convert them into a website like this one.

Useful resources

Below are a few pieces of reference material:

Quick start

A quick guide to updating the docs when you already know GitHub

Updating a single page

Quick edits from the desktop view

Previewing your changes locally

How to run your own local Hugo server to preview your changes

Creating an issue

How to report a problem or suggestion