Documentation
This site is Astro Starlight in docs/site/. It’s written in English, in Markdown, under src/content/docs/.
Preview it
Section titled “Preview it”cd docs/sitenpm cinpm run devnpm run dev reloads as you edit, but search needs the built site:
npm run buildnpm run previewThe build fails on a broken internal link, or if a page or API operation is missing from the output.
What goes where
Section titled “What goes where”| Page is for | Goes in |
|---|---|
| People using the product | guide/ |
| Whoever runs an instance | instance/ |
| Contributors | contributing/ |
| How the code is built, for maintainers | docs/, outside this site |
Generated content
Section titled “Generated content”- The API reference comes from
schemas/openapi.json, exported from the routes. - The glossary comes from the application’s own, in
frontend/src/locales/en.json, at build time.
Writing
Section titled “Writing”- Lead with what the reader needs to do.
- Use the interface’s own labels, in bold.
- Spell out role names in descriptive text: Exercise Planner, Exercise Program Manager.
- Check every statement against the code.
- Don’t describe planned work as if it were built.