Contributing to Docs
How to help improve our documentation.
Anyone can contribute to our documentation! You could fix an error you've spotted, update an outdated guide, or write up a tutorial for something that isn't covered yet. Contributing helps other clients get unstuck faster, and frees up our support team to help with more advanced requests.
Small fixes
For typos, broken links, or small corrections, open a pull request directly against the file you want to change in our documentation repository.
Bigger changes
For new pages or restructuring, fork the repository, make your changes, and open a pull request for the team to review.
Match the existing style
To keep things consistent, please:
- Use the same page frontmatter fields as similar pages (
title,description,type, andiconwhere relevant). - Use
##/###headers, adding\[step]to headers that represent a sequential step (see any "How To" page for an example). - Use the same admonition types (
:::tip,:::info,:::warning,:::danger) other pages use, rather than plain bold text for callouts. - Where an existing page already covers your topic (e.g. a shared install method or config file), link to it instead of repeating it.
🎉 Done
Submit your pull request, one of our team will review it and merge it in.
Not sure where to start?
If you're not confident making the change yourself, you're also welcome to just flag the issue via our Discord community support channel and we'll take a look.