Skip to content

docs: agent-first README rewrite#26

Merged
ashmitb95 merged 1 commit into
mainfrom
readme-agent-first-and-doc-sweep
May 31, 2026
Merged

docs: agent-first README rewrite#26
ashmitb95 merged 1 commit into
mainfrom
readme-agent-first-and-doc-sweep

Conversation

@ashmitb95

@ashmitb95 ashmitb95 commented May 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • README rewritten to lead with the multi-repo-coding-agent framing (which is what canopy actually is) instead of the workflow-narrative session example that read like an internal dogfooding demo.

Test plan

  • pytest tests/ — 857 passed, 0 failed
  • Read-through of the new README on GitHub before merging — voice / framing check

@ashmitb95 ashmitb95 changed the title docs: agent-first README rewrite + sweep dogfood ticket IDs docs: agent-first README rewrite May 31, 2026
README
- Replace the worked-session opener with a tight before/after code
  contrast. Multi-repo workspaces (backend+frontend, api+mobile,
  monolith+services) are the defining setting; lead with that. The
  table that follows enumerates the specific failure modes coding
  agents hit in that setting and which canopy primitive closes each.

Source sweep
- review_filter.py: drop "Validated against four real PRs (DOC-3008,
  DOC-3010, DOC-3029, DOC-2827)" citation from the module docstring.
- aliases.py / drift.py / switch.py / triage.py / coordinator.py /
  mcp/server.py: docstring examples using DOC-3010-UI-fixes / DOC-3029
  / docsum-api#1287 / doc-1002-api-only replaced with auth-flow /
  auth-flow-v2 / TEAM-101 / api#142 / auth-flow-api-only.
- using-canopy SKILL.md: DOC-2226 trigger-pattern examples replaced
  with TEAM-101. User-side mirror at ~/.claude/skills/using-canopy/
  SKILL.md kept in sync.

No behavior change. Full suite (857 tests) passes.
@ashmitb95 ashmitb95 force-pushed the readme-agent-first-and-doc-sweep branch from 987d9e1 to 3f04d96 Compare May 31, 2026 01:07
@ashmitb95 ashmitb95 merged commit ff77752 into main May 31, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant