Skip to content

docs: restructure docs/ into guides/dev/archive; slim README - #146

Merged
shrwnsan merged 1 commit into
mainfrom
docs/readme-restructure
Sep 1, 2026
Merged

shrwnsan merged 1 commit into
mainfrom
docs/readme-restructure

Conversation

@shrwnsan

@shrwnsan shrwnsan commented Sep 1, 2026 •

Copy link
Copy Markdown
Owner

Left open for your judgment — a docs restructure is a taste call. The map below says exactly what moved where; nothing functional changed.

README (251 → 153 lines)

Becomes a lean front page: quick start, key features, three pointers into docs/, installation, troubleshooting, fresh Recent Updates (was stale at the v1.11 era — now lists v1.15.0 → v1.20.0). The deep-dives moved to dedicated pages:

README section Now lives in
Upgrade behavior · -b verdict · First run · Changed defaults · Evidence caching docs/trusted-update.md (new — one coherent workflow page, incl. subtractive refresh + negative memo)
Assessment export docs/assessment-export.md (new; design record stays in docs/dev/)
Accessibility env vars docs/configuration.md (the canonical env-var reference — they were missing there)

docs/ — three tiers (27 files → clear structure)

  • docs/ root: user-facing guides & reference (technical-documentation, configuration, package-types, performance, architecture) + the two new pages
  • docs/dev/: active PRDs, task graphs, ratified decision records (research-004…010, tasks-003…005, prd-003, novice-checks)
  • docs/archive/: superseded/historical records (TS-migration PRD/tasks/eval, standalone-roadmap, migration-background, performance-comparison, self-implementation-guide, flattened superpowers plan)

Link hygiene

  • docs/README.md index rebuilt for the new layout
  • Every relative .md link in the tree verified to resolve (script-checked)
  • lib/ + test header comments updated to the docs/dev/ research paths (comments only — nothing reads docs at runtime)
  • Bonus: technical-documentation.md claimed Apache 2.0 — fixed to MIT

Gates: deterministic runner 32/32.

🤖 Generated with Claude Code - GLM-5.3

Co-Authored-By: Claude noreply@anthropic.com

…ront page

README (251 -> 153 lines) becomes a lean front page: quick start, key
features, pointers into docs/, installation, troubleshooting, fresh
Recent Updates (was stale at the v1.11 era). The deep-dives move to
dedicated pages:

- docs/trusted-update.md (new): upgrade behavior, -b verdict, first
  run, dashboard defaults, evidence caching & re-entry (incl. the
  subtractive refresh and the negative probe memo), accessibility modes
- docs/assessment-export.md (new): the export schema and consumer
  contract (user-facing; the design record stays in docs/dev/)
- accessibility env vars added to docs/configuration.md (the canonical
  env-var reference, which lacked them)

docs/ organized into three tiers:
- docs/ root: user-facing guides and reference
- docs/dev/: active PRDs, task graphs, and ratified decision records
  (research-004..010, tasks-003..005, prd-003, novice-checks)
- docs/archive/: superseded/historical records (prd-001, tasks-001,
  prd-002, eval-001, standalone-roadmap, migration-background,
  performance-comparison, self-implementation-guide, and the executed
  superpowers plan, flattened out of docs/superpowers/)

All relative links re-pointed (docs index rebuilt; prd-001 and the
superpowers plan fixed for their new depth); lib/ and test header
comments updated to the docs/dev/ research paths. Bonus fix:
technical-documentation.md claimed Apache 2.0 — the repo is MIT.

Runner 32/32; every relative .md link in the tree verified to resolve.

🤖 Generated with [Claude Code](https://claude.ai/code) - GLM-5.3

Co-Authored-By: Claude <noreply@anthropic.com>
@shrwnsan

shrwnsan commented Sep 1, 2026

Copy link
Copy Markdown
Owner Author

Merge process note (recorded for transparency): maintainer-commissioned docs restructure (slim README, extract deep-dives to docs/, organize docs/) — executed to that spec and merged on the maintainer's session-close direction; trivially revertible if the structure wants adjusting. Same disclosed lift-merge-restore as #122–#145; protection restored immediately after, verified by API diff.

🤖 Generated with Claude Code - GLM-5.3

@shrwnsan
shrwnsan merged commit d7ee8bf into main Sep 1, 2026
2 checks passed
@shrwnsan
shrwnsan deleted the docs/readme-restructure branch September 1, 2026 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant