Get guidance¶
The starter pack uses Sphinx as the documentation framework. It supports markup in both reStructuredText and Markdown with MyST.
It’s outside of the scope of the starter pack to teach you how to use these tools to create documentation, but you can check the Quickstart guide for a very brief introduction. For more detailed information and syntax guides, see the linked documents.
To make it easier for you to get started, and to keep our documentation consistent, the following style guides give recommendations and conventions for using reST and Markdown/MyST:
The starter pack also contains cheat sheets for both markup languages that allow to easily copy and paste the markup that you want.
See the doc-cheat-sheet.rst and doc-cheat-sheet-myst.md files.
Other resources¶
Canonical documentation uses Diátaxis.
The following documentation repository contains an example for how to implement this structure: