Skip to content
◉rd ord.net Docs

Authoring Public Docs

All new public pages for docs.ord.net live in apps/public-docs/src/content/docs/.

Add a page

Section titled “Add a page”
  1. Create a new .md or .mdx file under the appropriate section directory.
  2. Add frontmatter with at least title and description.
  3. Set sidebar.order when the page needs explicit ordering.
  4. Run npm run docs:check from the repo root before pushing.

Keep public and internal docs separate

Section titled “Keep public and internal docs separate”
  • Public docs belong in this app.
  • Internal engineering and ops docs belong in the repo’s top-level docs/ directory.
  • If a topic includes live hostnames, network details, secrets, incident procedures, or operator-only context, it stays internal.
Section titled “Recommended structure”
  • getting-started/ for first-use and onboarding material
  • guides/ for task-based walkthroughs
  • reference/ for stable public facts, interfaces, and definitions