Development
Find the source repository and contribution path for the part of BitRouter you want to change.
1 min readEdit this page
BitRouter is developed in the open. Use this page when you intend to change the product, its documentation, or its agent-facing setup rather than operate an existing deployment.
Choose the repository
| Change | Repository |
|---|---|
| Router, CLI, protocols, providers, policies, or generated OpenAPI source | bitrouter/bitrouter |
| Website, guides, API reference presentation, blog, or changelog | bitrouter/bitrouter-docs |
| Agent-install and setup skills | bitrouter/agent-skills |
Router contribution guide
Build, test, and submit changes to the Rust workspace.
Documentation guide
Follow the MDX, navigation, generation, and validation contract.
Documentation workflow
Most documentation is hand-authored .mdx. Two surfaces are generated and must be changed at their source:
- API endpoint pages come from
openapi.yamlthroughpnpm generate:openapi. - The CLI page comes from the binary snapshot and
cli-overlays/throughpnpm generate:cli.
Before opening a documentation change, run:
pnpm lint:docs
pnpm test
pnpm buildFor operating an existing binary, start with Self-hosting. For adding a model, provider, or router-owned tool without changing core behavior, start with Customization.
How is this guide?