Commit 418a730
chore: prune docs/ bloat — keep only screenshots; fix cross-link rot (#551)
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: Martin Castro Laminrs <mcastro@laminr.ai>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 0f6c4cd commit 418a730
51 files changed
Lines changed: 46 additions & 8474 deletions
File tree
- docs
- agents
- consumer
- product-manager
- security-expert
- software-architect
- consumer
- ux
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
14 | 12 | | |
15 | 13 | | |
16 | 14 | | |
| |||
216 | 214 | | |
217 | 215 | | |
218 | 216 | | |
219 | | - | |
220 | | - | |
| 217 | + | |
221 | 218 | | |
222 | 219 | | |
223 | 220 | | |
| |||
377 | 374 | | |
378 | 375 | | |
379 | 376 | | |
380 | | - | |
381 | | - | |
| 377 | + | |
382 | 378 | | |
383 | 379 | | |
384 | 380 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
459 | 459 | | |
460 | 460 | | |
461 | 461 | | |
462 | | - | |
463 | | - | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
464 | 465 | | |
465 | 466 | | |
466 | 467 | | |
| |||
531 | 532 | | |
532 | 533 | | |
533 | 534 | | |
534 | | - | |
535 | | - | |
| 535 | + | |
| 536 | + | |
| 537 | + | |
536 | 538 | | |
537 | 539 | | |
538 | 540 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
110 | 109 | | |
111 | 110 | | |
112 | 111 | | |
| |||
144 | 143 | | |
145 | 144 | | |
146 | 145 | | |
147 | | - | |
148 | | - | |
149 | | - | |
150 | | - | |
151 | | - | |
152 | | - | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
163 | 154 | | |
164 | 155 | | |
165 | 156 | | |
| |||
176 | 167 | | |
177 | 168 | | |
178 | 169 | | |
179 | | - | |
180 | | - | |
181 | | - | |
182 | | - | |
183 | | - | |
184 | | - | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
185 | 173 | | |
186 | 174 | | |
187 | 175 | | |
| |||
193 | 181 | | |
194 | 182 | | |
195 | 183 | | |
196 | | - | |
197 | | - | |
198 | | - | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
199 | 187 | | |
200 | 188 | | |
201 | 189 | | |
202 | 190 | | |
203 | 191 | | |
204 | | - | |
205 | | - | |
206 | | - | |
207 | | - | |
208 | | - | |
209 | | - | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
210 | 195 | | |
211 | 196 | | |
212 | 197 | | |
| |||
377 | 362 | | |
378 | 363 | | |
379 | 364 | | |
380 | | - | |
381 | | - | |
382 | | - | |
383 | | - | |
384 | | - | |
385 | | - | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
386 | 372 | | |
387 | 373 | | |
388 | 374 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
32 | 9 | | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
52 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
This file was deleted.
0 commit comments