Start here when you need to understand what is implemented today, what is planned next, and which architectural decisions are already settled.
Canonry is API-first. The API is the source of truth, the CLI is the standard operator surface, and the web UI is a secondary consumer for human analysts.
| Document | Label | Audience | Purpose |
|---|---|---|---|
README.md |
current | users, operators | Product overview, quickstart, key CLI/API entrypoints |
CONTRIBUTING.md |
current | contributors | Setup, workspace structure, and contribution rules |
CLAUDE.md |
current | agents, maintainers | Repo operating guidance and implementation priorities |
| Document | Label | Audience | Purpose |
|---|---|---|---|
architecture.md |
current | engineers | Current local architecture and planned deployment shape |
deployment.md |
current | operators | Current deployment and runtime guidance |
testing.md |
current | contributors | Validation and test workflow guidance |
providers/gemini.md |
current | engineers | Gemini provider behavior and constraints |
providers/openai.md |
current | engineers | OpenAI provider behavior and constraints |
providers/claude.md |
current | engineers | Claude provider behavior and constraints |
providers/local.md |
current | engineers | Local provider behavior and constraints |
google-search-console-setup.md |
current | operators | Google Search Console OAuth setup and usage |
bing-webmaster-setup.md |
current | operators | Bing Webmaster Tools API key setup and usage |
google-analytics-setup.md |
current | operators | Google Analytics 4 service account setup and usage |
| Document | Label | Audience | Purpose |
|---|---|---|---|
roadmap.md |
roadmap | founders, maintainers | Canonical product roadmap and prioritization |
docs/roadmap.md is the only product roadmap. Do not treat plans or ADRs as substitutes for roadmap priority.
| Document | Label | Audience | Purpose |
|---|---|---|---|
../plans/deployment-parity.md |
active plan | engineers, operators | Bring local, Docker, and hosted deployment paths into parity |
../plans/optimize-ai-calls.md |
active plan | engineers | Reduce provider cost and unnecessary repeat calls |
Plans describe implementation work. They are not current-behavior reference docs.
| ADR | Label | Purpose |
|---|---|---|
0001-root-package-workspace.md |
ADR | Keep @ainyc/aeo-audit as an external dependency |
0002-separate-score-families.md |
ADR | Keep technical readiness and answer visibility as separate score families |
0003-provider-throttling-and-quotas.md |
ADR | Use conservative provider throttling and quota defaults |
0004-local-llm-provider.md |
ADR | Support local LLMs via an OpenAI-compatible provider |
0005-distributed-node-hub-architecture.md |
ADR | Define the long-term distributed node and hub architecture |
0006-location-aware-tracking.md |
ADR (superseded) | Historical proposal for keyword-scoped location tracking |
0007-project-scoped-location-context.md |
ADR | Keep locations project-scoped and use them as run context |
README.md for product context and quickstart.architecture.md for the current shape of the system.roadmap.md for product direction and priorities.