Skip to main content

Docs Site Spec

apps/docs publishes the buyer-facing developer documentation from docs/app.

Responsibilities

  • starter-kit overview and adoption docs
  • product-surface and architecture summaries for evaluators
  • integration and API documentation for technical reviewers
  • deployment and customization guidance that belongs in the published docs surface

Non-responsibilities

  • internal developer setup docs
  • backend maintenance runbooks
  • temporary migration or audit notes
  • historical archive material that is only useful during repo cleanup

Publishing Rules

  • docs/app is the source of truth for the docs site
  • docs/dev stays repo-local and must not be mounted into Docusaurus
  • the main sidebar should prioritize starter overview, technical adoption guides, and stable reference material
  • planning notes and archived material should not be part of the primary published navigation