Project Manual
Contents

Basic Workflow

The normal authoring loop is intentionally short.

Write and check#

  1. Add or edit a Markdown page.
  2. Run python3 build.py.
  3. Preview the generated documentation.
  4. Commit source files, not generated output.

Use relative links between pages so the generator can rewrite them for the selected deployment path. See configuration for the available build option.

Add a page#

Create a file with the next available two-digit prefix:

manual/02-using-the-project/03-new-page.md

Its first line must be a single H1, such as # New Page.