Skip to content
Scoutica Protocol

Documentation instructions

Documentation project instructions

Section titled “Documentation project instructions”

Scoutica’s documentation site uses Astro with Starlight. Source pages live in docs/src/content/docs/; navigation lives in docs/astro.config.mjs.

Local commands

Section titled “Local commands”

Run these commands from the repository root:

Terminal window
npm --prefix docs ci
npm --prefix docs run dev
npm --prefix docs run check:links
npm --prefix docs run check:claims
npm --prefix docs run build

Style

Section titled “Style”
  • Use active voice and address the reader as “you.”
  • Keep sentences concise and headings in sentence case.
  • Put commands, paths, and field names in code formatting.
  • Keep capability and privacy claims tied to behavior that the repository tests.
  • Add new public pages to the Starlight sidebar when users must navigate to them.