Read the docs · Live app · App repository · Website
This repository is the source of the technical documentation portal for Chorus, an anonymous discussion platform that stores every thread and message as a commit in a Git repository. The portal is a static site served at docs.joinchorus.app.
Note
Chorus is in early development (v0.1.0-alpha). The REST API documented here is unstable and may change before v1.0.0.
The REST API lives under /api/v1 (also reachable as /api/v0.1). The portal documents seven endpoints:
| Method | Path | Purpose |
|---|---|---|
GET |
/healthz |
Health check probe |
POST |
/api/v1/identities |
Register a session identity |
GET |
/api/v1/threads |
List threads |
POST |
/api/v1/threads |
Create a thread |
POST |
/api/v1/threads/{id}/messages |
Post a message to a thread |
POST |
/api/v1/threads/{id}/messages/{msg_id}/translate |
Translate a message |
POST |
/api/v1/moderation/reports/{id}/action |
Act on a moderation report |
Each endpoint block lists purpose, parameters, status codes, an example curl request and an example JSON response. The same portal also covers:
- Architecture: an 8-layer component diagram, from browser client to the native Git repository, and a 9-stage write lifecycle diagram.
- Git persistence: the storage engine specification, with the formal write-up in RFC-001.
- Operations: deployment configuration, contributing guidelines and a roadmap.
- Search: press
/orCmd/Ctrl+Kto filter the portal.
A machine-readable OpenAPI file is also in public/. Note that it describes a smaller set of paths than the portal page.
The site is plain static files in public/, so there is nothing to build.
git clone https://github.com/joinchorus/docs.git
cd docs
npm run serve # runs `npx serve public`, then open http://localhost:3000| Path | Contents |
|---|---|
public/ |
The deployed site: index.html, openapi.yaml, favicon, sitemap |
rfcs/ |
Architecture RFCs (RFC-001: Git persistence) |
event_architecture.md |
Immutable event architecture and auditability |
PERFORMANCE.md |
Benchmarks and load testing report |
DEPLOYMENT.md |
Production deployment and reliability guide |
release_notes_v0.1.0-alpha.md |
Release notes for v0.1.0-alpha |
A push to main runs .github/workflows/ci-cd.yml, which checks that public/index.html exists and deploys public/ to Firebase Hosting (project chorus-chat-app, target chorus-docs). Pull requests run the check only.
Corrections and improvements are welcome. See CONTRIBUTING.md before opening a pull request. To report a vulnerability, read SECURITY.md and use private vulnerability reporting instead of a public issue.