Skip to content

README.md

Latest commit

 

History

History
33 lines (21 loc) · 991 Bytes

README.md

File metadata and controls

33 lines (21 loc) · 991 Bytes
Raw

OpenChamber Docs Source

This package is the source-of-truth for OpenChamber public docs content.

Layout

  • content/docs/*.mdx - English docs pages (source of truth)
  • content/docs/<locale>/*.mdx - translations, mirroring the English filenames (e.g. uk/, zh-cn/, pt-br/, fr/); see CONTRIBUTING.md → Localization
  • sidebar.config.json - docs navigation structure for Starlight sidebar
  • CONTRIBUTING.md - authoring guide for adding pages, sections, and translations
  • DEPLOYMENT.md - release/manual packaging and sync trigger model

Local validation

Run from repo root:

bun run docs:validate

This validates:

  • frontmatter (title, description) exists for every MDX page
  • sidebar links resolve to existing MDX routes

Deployment model

This repo owns docs content.

Website rendering/deployment happens in openchamber-website (apps/docs).

Use .github/workflows/docs-source.yml to package docs source on release or manual trigger.