chore: prune docs/ bloat — keep only screenshots, fix cross-link rot#551
Merged
Conversation
Owner directive: minimal docs, focused on shipping. After #550 collapsed this repo to the React-super-layer, most of `docs/` either described the local API (now gone, in `django-admin-rest-api`) or agent governance (sole-agent mode now). ## Deleted (47 files) - `docs/agents/` — agent governance, autonomy policy, decisions log, PR workflow, per-role subdirs. None of it applies in sole-agent mode. - `docs/api-contract.md` — wire contract for `django-admin-rest-api`; belongs in that repo, not duplicated here. - `docs/extensions.md` — extension API doc that was already marked "not yet implemented" + the wiring lives in the API repo. - `docs/threat-model.md` — STRIDE threat model. SECURITY.md is the durable security document; per-endpoint threat surface is now an API-repo concern. - `docs/data-layer.md` — frontend data-layer internals; SPA-only and the code is its own documentation. - `docs/ux/` — UX principles / nav / responsive / a11y / PWA. Was the PM agent's internal doc — sole-agent mode has no PM agent. - `docs/consumer/` — pilot requirements; internal-only. ## Kept - `docs/screenshots/` (6 PNGs + README) — referenced from `README.md` for the PyPI landing page. - `docs/README.md` — trimmed to a 1-paragraph pointer at the screenshots + the root docs. ## Cross-link rot fixed - `README.md`: dropped the "see `docs/extensions.md`" ref (API-repo concern) and "Full wire contract: `docs/api-contract.md`" (the API repo owns it). - `ARCHITECTURE.md`: dropped 3 references to deleted docs/ files (decisions log, M2M ADR pointer, `installation.md`). - `SECURITY.md`: surgically removed every ref to `docs/agents/`, `docs/threat-model.md`, `tests/test_security.py` (deleted with the API in #550), and the now-obsolete CI-revisit prose. The §10 cross-references now point at README + ARCHITECTURE + the API repo's SECURITY. ## Verification - 42 SPA tests pass (unchanged from #550). - No remaining dead `docs/*` references in any of the 4 surviving root `.md` files. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Follow-up to #550 (the React-super-layer collapse). After the local API was deleted, most of
docs/either described it or was agent-governance overhead that no longer applies in sole-agent mode.Deleted (47 files)
docs/agents/docs/api-contract.mddjango-admin-rest-apirepo.docs/extensions.mddocs/threat-model.mddocs/data-layer.mddocs/ux/,docs/consumer/Kept
docs/screenshots/(6 PNGs + README) — referenced by README for the PyPI landing page.docs/README.md— trimmed to a one-paragraph pointer.Cross-link rot fixed
README.md: droppeddocs/extensions.md+ localdocs/api-contract.mdrefs (API-repo concern).ARCHITECTURE.md: dropped 3 deaddocs/agents/+docs/installation.mdrefs.SECURITY.md: surgical removal of everydocs/agents/,docs/threat-model.md, andtests/test_security.py(deleted with the API in chore: collapse to the React-super-layer — drop the local API, the API tests, and excess docs (#544) #550) reference. §10 cross-references now point at the API repo'sSECURITY.mdfor API-side concerns.Verification
docs/*references in any of the 4 surviving root.mdfiles (README, ARCHITECTURE, SECURITY, LICENSE).Tier 1 (docs only).
🤖 Generated with Claude Code