Skip to content
AI OSAI OS Docs

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.

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”
Terminal window
bun run docs:check
bun run docs:scan
bun run docs:build

The 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.

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.