Contributing to public documentation
Public reader pages live only under docs-site/src/content/docs/. Repository
maintenance documents remain separate and are never imported automatically.
The maintained repository documentation remains the implementation source. Public pages consolidate durable operator and reader guidance; internal plans, route contracts, provider diagnostics, source-compliance working notes, and historical evidence stay unpublished.
Author a page
Section titled “Author a page”Every page needs a unique title, meaningful description, owner, review date, and publication status. Describe shipped behavior first and name planned or environment-limited behavior explicitly.
Use draft: true while a page should appear only in local development or a
preview. Use publicationStatus: deprecated only when the visible page includes
a replacement or removal path.
Validate
Section titled “Validate”bun run docs:checkbun run docs:scanbun run docs:buildThe scanner blocks private path shapes, secret-shaped values, local-only route references, parent-tree imports, and symbolic links. The production build checks internal routes and required output files.
When a repository document changes, either update its public topic owner or
record why the source remains maintenance-only in the dated repository-docs
coverage map under docs-site/migration/. A new source file should never be
silently omitted from the next comprehensive review.
Review checklist
Section titled “Review checklist”- Confirm commands against the current repository.
- Keep AI OS, Trend Finder, AI Rogue, and inherited names within their owners.
- Remove private local detail and provider-specific output.
- Give meaningful images descriptive alternative text.
- Verify keyboard order, focus, headings, contrast, and mobile layout.
- Check the Cloudflare preview before merging.
- Update
lastReviewedonly after checking the page against its current source owners and any implemented code needed to resolve conflicting claims.