Writing Documentation

Read time 1 minute

---

Documentation lives in the docs folder as Markdown files. Keep each page focused on one task or topic, and write for someone encountering it for the first time.

Add a page

1. Create a Markdown file in docs, using a short, descriptive filename.
2. Start with a title and a sentence explaining the page's purpose.
3. Add the page to the sidebar in docs/.vitepress/config.mjs.
4. Preview the page, check its links, and review the wording.

Suggested page structure

• Purpose: What will the reader learn or accomplish?
• Before you begin: What do they need?
• Steps: What should they do, in order?
• Result: What should happen, and how can they check it?
• Related pages: Where can they go next?

Use clear labels and tested instructions. Mark anything that still needs verification, and avoid including private files or credentials.