CodeAgora docs are organized by audience.
Current release: 0.1.2.
| Audience | Path | Use when |
|---|---|---|
| Users | for-users/ |
Installing, configuring, running the CLI, using providers, GitHub integration, troubleshooting. |
| Agents / maintainers | for-agents/ |
Understanding architecture, implementation contracts, benchmark plans, research, and release readiness. |
| Historical reference | archived/ |
Reading dated plans, release notes, evidence snapshots, and superseded docs. |
| Document | Purpose |
|---|---|
for-users/CLI_REFERENCE.md |
CLI commands and options. |
for-users/CONFIGURATION.md |
CodeAgora configuration. |
for-users/PROVIDERS.md |
Provider setup and status. |
for-users/GITHUB_ACTIONS_SETUP.md |
Quick-start/current GitHub Actions setup guide. |
for-users/DEMO_RUNBOOK.md |
High-end demo script for CLI, MCP, Desktop, and GitHub Action. |
for-users/DEMO_PRESENTATION_PACKAGE.md |
Five-minute and 10+ minute CodeAgora demo/presentation script, cue card, fallback card, and Q&A. |
for-users/DEMO_ASSET_MANIFEST.md |
Fillable manifest for live demo assets, fallback evidence, and rehearsal readiness. |
for-users/5_GITHUB_INTEGRATION.md |
Deep GitHub integration/spec reference. |
for-users/DESKTOP.md |
Desktop app setup, gates, and release evidence. |
for-users/TROUBLESHOOTING.md |
Common failures and fixes. |
archived/release-notes-0.1.2.md |
v0.1.2 stable release notes and evidence links. |
archived/release-notes-0.1.1.md |
v0.1.1 stable patch release notes. |
archived/release-notes-0.1.0.md |
v0.1.0 stable release notes and evidence links. |
| Document | Purpose |
|---|---|
for-agents/1_PRD.md |
Product requirements and target scope. |
for-agents/ARCHITECTURE.md |
Current pipeline architecture. |
for-agents/AGENT_CONTRACT.md |
Agent/reviewer contract. |
for-agents/DEVELOPMENT.md |
Local setup, checks, and release/doc pointers. |
for-agents/BENCHMARKS.md |
Benchmark fixture set, offline gate, and live snapshot notes. |
for-agents/BENCHMARK_MEASUREMENT_PLAN.md |
Benchmark measurement dimensions and model matrix. |
for-agents/BENCHMARK_RESULTS_2026_05_30.md |
Latest live golden-bug benchmark results and model/config comparison. |
for-agents/PRODUCTION_READINESS_ROADMAP.md |
Release readiness gates and roadmap. |
for-agents/STABLE_READINESS.md |
Current v0.1.2 stable readiness audit and release evidence gates. |
for-agents/RC6_USABILITY_ROADMAP.md |
rc.6 usability-hardening plan for CLI, GitHub Action, MCP, Desktop, docs, and evidence. |
for-agents/papers/ |
Topic papers for the system design. |
- Keep current source-of-truth docs in
for-users/orfor-agents/. - Move dated plans, run reports, and superseded evidence to
archived/. - Prefer linking from this README instead of leaving many loose top-level files.