Skip to main content

Internal docs split

The repository root docs/ folder remains the source for internal engineering notes, runbooks, PRDs, incident reports, and implementation-specific material.

The apps/docs site owns public-facing API guides, API reference material, and customer help content.

When moving content from root docs/ into apps/docs, keep this split:

Public docsInternal docs
API authentication and usageOperational runbooks
Customer-facing helpIncident reports
Stable endpoint contractsImplementation notes
Integration guidesSecurity reviews and private deployment details

Do not publish secrets, internal hostnames, private customer data, or unfinished implementation plans to apps/docs.