docs: restructure docs/ tree into user/concepts/design/audits buckets - #812
Conversation
There was a problem hiding this comment.
Sorry @robotrocketscience, your pull request is larger than the review limit of 150000 diff characters
|
Important Review skippedIgnore keyword(s) in the title. ⛔ Ignored keywords (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR-size soft capThis PR is over the advisory size threshold:
Bigger PRs collide with more open work, which under the parallel-session workflow tends to produce repeated This is advisory only — nothing is blocked. If the size is intentional (large refactor, module removal, generated code), apply the |
Triage — labels added; pytest failures need addressing on rebaseBypassed
Pure path-rewrite misses; the first two need their Discretion grep on the diff — flagged hits are existing public-surface release-note / README content being relocated between docs paths (e.g. "subagent" / "Claude Haiku" / "Anthropic SDK" all appear in current No |
|
[claim:review:Prince:2026-05-14T22:02:46Z] |
The docs/ root went from 75 flat .md files to 4 audience-keyed
subdirectories. Mapping:
docs/user/ operational reference (8 files): QUICKSTART, INSTALL,
COMMANDS, SLASH_COMMANDS, MCP, CONFIG, PRIVACY,
LIMITATIONS.
docs/concepts/ background (6 files): ARCHITECTURE, PHILOSOPHY,
ROADMAP, BENCHMARKS, RELEASING, HARNESS_INTEGRATION.
docs/design/ internal specs (60 files): pre-existing design/ folder
expanded with all feature-*.md, v2_*.md, v3_*.md, and
lowercase implementation notes.
docs/audits/ point-in-time snapshots (1 file): CLI_SURFACE_AUDIT.
adr/, assets/, bake_off_results/, experiments/ unchanged. New top-level
docs/README.md and per-bucket README.md files explain what each holds.
Cross-references rewritten in: README.md, CONTRIBUTING.md, SECURITY.md,
all .md files inside docs/, all .py files in src/ tests/ benchmarks/
scripts/, and 3 workflow YAMLs (post-release-docs-issue, replay-soak,
staging-gate). CHANGELOG.md intentionally not rewritten — left to a
follow-up after the per-major split (#811) merges.
Three tests reference old top-level docs paths: - test_ac12 reads docs/LIMITATIONS.md → moved to docs/user/LIMITATIONS.md - test_ac13 reads docs/ROADMAP.md → moved to docs/concepts/ROADMAP.md - test_ac1 entity-index fixture expected lowercase 'docs/roadmap.md'; the body text now references docs/concepts/ROADMAP.md, so the extracted entity is 'docs/concepts/roadmap.md' Pure path-rewrite to match the restructure in the parent commit.
2c3fec6 to
4f9d537
Compare
|
[release:review:Prince:2026-05-14T22:29:08Z] |
|
Picked up by prince. Rebased onto github/main (clean rebase, the conflict label was stale once the docs/-bucket parents had moved on), and added a
Local pytest sweep: 4139 passed, 62 skipped, 75 xfailed in 84s (3.13). Push went through Carrying the previous size soft-cap advisory: this PR is 155 files / 686 lines because it's a docs restructure. Apply Branch is FF-pushable on current |
|
[claim:review:clarke:2026-05-14T22:35:57Z] |
Review verdict: approve-equivalentRebased FF on
Both signed ( Discretion check — additions-only grep flags three lines containing Adding |
|
[release:review:clarke:2026-05-14T22:37:13Z] |
|
merge-train: merged 4f9d537 → |
Summary
docs/went from 75 flat .md files to 4 audience-keyed buckets:docs/user/docs/concepts/docs/design/feature-*.md,v[23]_*.md, lowercase implementation notes)docs/audits/CLI_SURFACE_AUDIT.md)adr/,assets/,bake_off_results/,experiments/unchanged. Newdocs/README.mdand per-bucketREADME.mdfiles explain what each holds (visible on GitHub's directory view).Why
Anyone clicking
docs/on GitHub landed on a wall of 75 files mixing user-facing reference and internal design notes with no signal which was which. README's "Documentation" section had to use prose to point readers at the right files. The bucket split lets the directory view do that work.Cross-reference rewrites
Every
docs/X.mdreference was updated to its new bucketed path. Touched files:README.md,CONTRIBUTING.md,SECURITY.md.mdinsidedocs/— intra-doc links rewritten (e.g. concepts/ARCHITECTURE.md →../user/LIMITATIONS.md).pyinsrc/,tests/,benchmarks/,scripts/— docstring referencespost-release-docs-issue.yml,replay-soak.yml,staging-gate.ymlCHANGELOG.mdintentionally not rewritten in this PR — would conflict with #811 (CHANGELOG split). Follow-up after both merge.Conflict potential with #811
Both PRs touch
staging-gate.ymlandpost-release-docs-issue.ymlbut in different sections (#811: CHANGELOG paths; this PR: docs/ROADMAP.md → docs/concepts/ROADMAP.md). Should merge cleanly. If it conflicts, merge #811 first and rebase this PR.Note on pre-push discretion override
Push triggered
BANNED_VOCAB(Check 2) on lines likeClaude Haiku,ANTHROPIC_API_KEY,Claude Code's auto-memoryinside renamed files (e.g.docs/concepts/ARCHITECTURE.mdwas previouslydocs/ARCHITECTURE.md). The flagged content is verbatim already ongithub/main— git renames carry the file content as additions in the diff even though no new occurrences are introduced. One genuinely-new line indocs/concepts/README.mdwas reworded ("Claude Code's auto-memory" → "host agent's built-in memory") before push. UsedALLOW_DISCRETION_OVERRIDE=1for the rename-derived false positives (logged to~/.aelfrice/discretion-override.log).Verification
git status --short | wc -l→ 155 entries (75 renames + 5 new READMEs + 75 link rewrites).README.mdline 175-178: all bucketed correctly (user/, concepts/).docs/concepts/ARCHITECTURE.mdline 9:[LIMITATIONS](../user/LIMITATIONS.md)— cross-bucket relative link works.docs/concepts/ARCHITECTURE.mdline 124:[entity_index.md](../design/entity_index.md)— concepts→design relative link works.Test plan
staging-gate / pytestmatrix passes (no behavior changes; docstring edits only on Python side).link-checkworkflow (cron-only, weekly) — broken-link issue should not be opened next Monday.docs/on the PR's GitHub tree view — bucket directories visible with README chips.README.mdrendered — all "Documentation" section links resolve to the new paths.docs/concepts/ARCHITECTURE.mdcross-links render correctly on GitHub.