Skip to content

Getting Started

The public docs.ord.net site lives in apps/public-docs/.

  1. Install the docs app dependencies.
Terminal window
npm --prefix apps/public-docs install
  1. Start the Starlight dev server from the repo root.
Terminal window
npm run docs:dev
  1. Run the docs checks before pushing changes.
Terminal window
npm run docs:check
  • Public docs content belongs under apps/public-docs/src/content/docs/.
  • The repo’s top-level docs/ tree stays internal-only.
  • Do not copy topology, host inventory, secret-source, or runbook material into the public docs app.