Files
openchamber/packages/docs
Bohdan Triapitsyn 7ea974d89b docs: centralize device connection guides, add private relay docs
- new Connect a Device page: one-time QR pairing, transport choices, device management
- new Private Relay page: E2EE guarantees, demand-driven lifecycle, relay vs tunnel
- rewrite mobile page around the native iOS/Android apps (TestFlight + APK)
- update remote-instances, security, tunnels, and remote-access troubleshooting to point at the new pairing flow
- translate everything across all 8 locales and update the sidebar
2026-07-10 15:30:50 +03:00
..

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.