Contribute

You can contribute to this documentation on GitHub, with an issue or a pull request.

Before you write

Before you start new content, open a GitHub issue to describe it. This lets the team discuss the topic with you and check that nobody already works on it.

Write and check your content

The documentation uses Markdown files and Hugo with the Hextra theme. The contributing guidelines describe the writing standards, and the README explains how to install the tools, preview the site, and run the checks.

Before you open a pull request, build the site with hugo and run markdownlint and Vale on the files you change. Fix every error and warning on the lines you change, and review each Vale suggestion.