Bohdan Triapitsyn
ca33c6ae57
Add a Voice & Style section to the docs authoring guide, then bring every docs page in line with it: lead with the task, add success signals to procedures, explain jargon on first use, keep bullet casing consistent, and link out to Troubleshooting where steps can fail. Applied across English source and all localized versions (uk, zh-cn, es, pt-br, ko, pl).
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/); seeCONTRIBUTING.md→ Localizationsidebar.config.json- docs navigation structure for Starlight sidebarCONTRIBUTING.md- authoring guide for adding pages, sections, and translationsDEPLOYMENT.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.