We invite you to take part in creating and maintaining documentation. Here are some notes to get you started.
- Fork the repository. Try it out first, if you prefer.
- Choose the right content, edit it, and commit. You can do this as many times as needed.
- Create a pull request and enter the information about your edits.
After you create the pull request, we'll review the content. We may also add some notes and comments in the pull request.
You can roughly classify the documentation in one of the three groups of content:
- 📘 conceptual (intros and docs about how things work - example)
- 🔨 procedural (mostly numbered lists on how to do something - example)
- ℹ️ referential (usually tables listing extra details - example)
It's generally more straightforward to create and edit procedural and referential content.
We use the Markdown markup language to write the documentation. Check this syntax overview to get started.
Thank you! 