How to Write Docs¶
This repo uses MkDocs with the Material theme.
Adding a page¶
- Create a new
.mdfile under the relevant section folder indocs/. - Add it to the
nav:section inmkdocs.yml. - Preview locally with
mkdocs servebefore committing.
Style¶
- Keep pages focused on one topic.
- Prefer short paragraphs and bullet lists over long prose.
- Use relative links to reference other docs pages.