This repository is the source of docs.joinchorus.app: the REST API reference, architecture diagrams and RFCs for Chorus. Changes to the application itself belong in joinchorus/chorus and follow the organization contributing guide.
The portal is static HTML; there is no build step.
git clone https://github.com/YOUR_USERNAME/docs.git
cd docs
npm run serve # npx serve public, prints the local address (default http://localhost:3000)Requirements: Node.js 22 or newer (only for npx serve).
| Path | Content |
|---|---|
public/index.html |
The portal: API reference, diagrams, search |
public/openapi.yaml |
OpenAPI description (covers fewer paths than the portal page) |
rfcs/ |
Architecture RFCs, e.g. RFC-001-git-persistence.md |
*.md |
Event architecture, performance, deployment, release notes |
- The API is defined by
internal/http/router.goin the app repo. When you document or change an endpoint, check its method, path, request and response against the code. - Describe what exists today. Mark planned behaviour as planned.
- New architectural proposals go in
rfcs/asRFC-NNN-short-title.mdand are discussed in the pull request.
- Branch from
main(docs/...,fix/...). - Use Conventional Commits (
docs: document report endpoint). - Open a pull request using the template. CI checks that
public/index.htmlis present; a maintainer review is required. - Merging to
maindeploys to docs.joinchorus.app, so preview your change locally before asking for review.
Security issues: please do not open a public issue. Use private vulnerability reporting or see SECURITY.md.