Files
openchamber/packages/docs
Bohdan Triapitsyn 6ec1797583 feat(cli): make connect-url --relay a full anywhere pairing link
- --relay links now carry both routes: direct LAN plus relay fallback,
  matching the UI's Anywhere pairing; devices prefer the direct route
- pairing sessions created by the CLI are marked with usesRelay, and the
  server reconciles relay demand on a timer, so a headless instance
  brings the relay up on its own after connect-url --relay
- warn with LAN_UNREACHABLE when the link's direct route points at
  loopback and other devices cannot use it
- document the --relay flow and the --lan binding caveat in Connect a
  Device and Remote Instances across all locales
2026-07-10 18:29:15 +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.