docs: 3.1.0 audit — README + architecture + workspace + AGENTS#25
Merged
Conversation
Refresh docs to reflect Wave 3.0 (slot model) and Plan 2 (feature_resume brief + GH thread mutations). Earlier docs were pinned to pre-3.0 numbers and module layouts. Rewrites - README.md (185 → 215 lines): 67 tools / 857 tests / 9 states / slot layout / canopy resume + thread mutations / updated agent-contract pitch. Failure-mode table picks up the session-re-derivation row. - docs/architecture.md (244 → 321 lines): current actions/ tree (adds slots, slot_load, slot_details, migrate_slots, last_visit, resume, thread_actions, thread_resolutions, bot_resolutions, bot_status, augments, bootstrap, conflicts, draft_replies, historian, ide_workspace, ship; drops active_feature, realign). New "Slot model internals" section covering slots.json schema, in_flight transaction marker, LRU policy. New "Plan 2 — resume + threads" callout. State files table now lists slots.json, visits.json, thread_resolutions.json, bot_resolutions.json. - docs/workspace.md (252 → 329 lines): correct .canopy/worktrees/ worktree-N/<repo>/ layout, all six state files documented with schemas, canopy.toml example uses [workspace] slots = N, features.json example shows a single-repo feature, alias section adds worktree-N slot id. - AGENTS.md (103 → 228 lines): adds the entire actions/ layer, current test count (857), state-files table, recipes for new action / state file / bundled skill / augment key. JSON output contract refreshed. Surgical edits - docs/architecture/providers.md: status block "lands in M5" -> "shipped in M5"; broken link fix; M3 ship status reflected in §8. - src/canopy/agent_setup/skills/augment-canopy/SKILL.md: drop "(when shipped)" / "(deferred)" qualifiers now that M3 + doctor have landed. Light audit - docs/concepts.md: verified clean (9 states match feature_state.py, slot default 2 matches config.py, resume brief shape matches resume.py, historian functions exist as described). No changes. - src/canopy/agent_setup/skills/using-canopy/SKILL.md: verified clean (67 tools, 21 doctor codes, issue_get tool registered). No changes. Cleanup - Deleted docs/test-findings.md (canopy 0.5.0 historical report) - Deleted github-issue-active-context.md (proposal superseded by slot model in 3.0.0) - Archived docs/test-plan.md -> docs/archive/test-plan.md (M0-M5 integration scaffold, pinned in time)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
feature_resumebrief + GH thread mutations). Most of these files were pinned to pre-3.0 numbers (43 MCP tools, 436 tests, 8 states) and showed the old worktree layout.README.md,docs/architecture.md,docs/workspace.md,AGENTS.md.docs/architecture/providers.md(M5 status),src/canopy/agent_setup/skills/augment-canopy/SKILL.md(drop "(when shipped)" qualifiers).docs/concepts.md,src/canopy/agent_setup/skills/using-canopy/SKILL.md— both were curated through Plan 2's milestone reviews and remain accurate.test-plan.md.Rewrites at a glance
README.mdcanopy resume+ thread mutations / session-re-derivation row in the failure-mode tabledocs/architecture.mdactions/tree (dropsactive_feature.py,realign.py; adds slot model + Plan 2 modules). New "Slot model internals" + "Plan 2 — resume + threads" sections. State files table coversslots.json,visits.json,thread_resolutions.json,bot_resolutions.jsondocs/workspace.md.canopy/worktrees/worktree-N/<repo>/layout, all six state files documented with schemas,[workspace] slots = Nexample, partial-scope features.json example,worktree-NaliasAGENTS.mdactions/layer (was invisible), refreshes test count, adds recipes for new action / state file / bundled skill / augment key, current JSON output contractCleanup
docs/test-findings.md— canopy 0.5.0 historical report; git history retains itgithub-issue-active-context.md— proposed "active feature" was implemented as the slot model and supersededdocs/test-plan.md→docs/archive/test-plan.md— M0–M5 integration scaffold, pinned in timeTest plan
main)__version__,pytest --collect-only,grep @mcp.tool,grep "code=" doctor.py).mdfiles render correctly (markdown lint clean — no<feature>/<repo>/layouts in fresh references; references to oldmax_worktrees/active_feature.jsonremain only in migration callouts)concepts.md#4-the-canonical-slot-modelanchor →#4-the-slot-modelrename was applied in workspace.md)