Sync repo-level docs to v0.5.0 (0.5.1)#46
Merged
Conversation
Doc-only release. Brings the root-level docs in line with what shipped
in v0.4.7 through v0.5.0 (manifest as default, hand-maintained docs
convention, doc-coverage CLI, derived-files orchestrator) and removes
implemented planning artifacts.
### Updated
- **README.md** — full rewrite. v0.5.0 status, 733 tests. Adds: four-
layer model, ownership rule, tier model (project-root / service-repo
/ single-repo), table of what dotagent generates, table of what it
never writes (hand-maintained convention), doc-coverage CLI section,
derived files (service-registry / HISTORY / dashboard), v3 manifest
architecture diagram, refreshed comparison table, troubleshooting.
Old text emphasizing CCO migration + Auto-Dream details kept but
scaled back.
- **CHANGELOG.md** — backfilled entries for 0.4.7 → 0.5.0 (was stuck
at 0.4.6). Plus this PR's 0.5.1 entry.
- **USING_WITH_CLAUDE_CODE.md** — trimmed to a focused practical guide.
Updated to v3-default + auto-regen-on-docs-change + doc-coverage
prompt for Claude. Drops the "what's not yet built" section that
listed long-shipped items.
- **CODA_PROMPT.md** — added Section 8.5 (~140 lines) covering every
v0.5 change for the Coda orchestrator team:
· render default flipped + adapter body identical across tools
· four invariant layers in every manifest
· hand-maintained docs convention (FM-### + ops/* + sharded
registries)
· `dotagent doc-coverage` CLI with severity model
· derived-files orchestrator (service-registry / HISTORY / dashboard)
· service-repo as child of project-root (../-INHERITED pointers)
· auto-regeneration on docs change
· manifest preview CLI
· quick v0.5 cheat sheet
### Removed
- **CLAUDE_MD_V2_PLAN.md** (494 lines) — v2/v3 design plan; manifest
shipped and stable since 0.5.0.
- **IMPLEMENTATION_PLAN.md** (856 lines) — v0.4 layered architecture
plan; all 14 PRs shipped.
- **CODE_AUDIT_PLAN.md** (706 lines) — future-feature plan that's not
yet started; spec lives in git history if revived.
- **PROJECT_CONTEXT.md** (259 lines) — last updated for v0.3.0;
superseded by README + docs/.
Total removed: 2315 lines of pre-implementation planning docs.
### Internal
Two stale code-comment references to the removed plan docs updated:
- `src/dotagent/render/__init__.py` — points at `docs/CLAUDE_MD_DESIGN.md`
- `src/dotagent/migration/detector.py` — inlined the description
### Untouched
- CONTRIBUTING.md (current, well-written)
- CODE_OF_CONDUCT.md (standard)
- LICENSE
- examples/
Full suite: 733 passed, 2 skipped.
Version: 0.5.0 → 0.5.1.
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
2 participants
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
Doc-only release. Brings root-level docs in line with v0.5.0 (manifest as default, hand-maintained convention, doc-coverage CLI, derived-files orchestrator) and removes 2315 lines of pre-implementation planning docs for features that have shipped.
Updated
README.md— full rewrite. v0.5.0 status (733 tests), four-layer model, ownership rule, tier model, what gets generated, what dotagent never writes (hand-maintained convention), doc-coverage CLI, refreshed architecture diagram + comparison table.CHANGELOG.md— backfilled 0.4.7 → 0.5.0 entries (was stuck at 0.4.6) + 0.5.1 for this PR.USING_WITH_CLAUDE_CODE.md— trimmed to focused practical guide. Updated for v3-default + auto-regen-on-docs-change + doc-coverage prompt.CODA_PROMPT.md— added Section 8.5 (~140 lines) covering every v0.5 change for the Coda orchestrator team: manifest default flip, adapter body parity, hand-maintained docs,dotagent doc-coverage, derived-files orchestrator, service-repo inheritance, auto-regen, manifest preview CLI, plus a quick v0.5 cheat sheet.Removed
CLAUDE_MD_V2_PLAN.mdIMPLEMENTATION_PLAN.mdCODE_AUDIT_PLAN.mdPROJECT_CONTEXT.mdInternal
Two stale code-comment references to the removed plan docs updated:
src/dotagent/render/__init__.py→ points atdocs/CLAUDE_MD_DESIGN.mdsrc/dotagent/migration/detector.py→ inlined the descriptionUntouched
CONTRIBUTING.md(current, well-written)CODE_OF_CONDUCT.md(standard)LICENSEexamples/Test plan
grep -r CLAUDE_MD_V2_PLAN\|IMPLEMENTATION_PLAN\|CODE_AUDIT_PLAN\|PROJECT_CONTEXT src/ tests/ docs/ *.md— only historical CHANGELOG entry remains (intentional).Version
0.5.0 → 0.5.1Generated by Claude Code