Skip to content

How to Write Docs

This repo uses MkDocs with the Material theme.

Adding a page

  1. Create a new .md file under the relevant section folder in docs/.
  2. Add it to the nav: section in mkdocs.yml.
  3. Preview locally with mkdocs serve before 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.