docs: reorganize docs/, delete bmad archive, add mkdocs site#17
Merged
Conversation
11 atomic-commit tasks covering: inline the load-bearing decoder rationale before archive deletion, git-mv workflow artifacts to planning/, move engineering.md and CONTRIBUTING.md into docs/dev/, thin root CONTRIBUTING.md stub, bulk path-reference update with sed (this plan and the spec excluded), README refactor, add mkdocs.yml / .readthedocs.yaml / docs/requirements.txt / docs/index.md, delete docs/archive/, verify lint+test+strict-build, post-merge RTD provisioning checklist. 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
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
docs/archive/(~5,000 lines of bmad-era PRD / architecture / epics / product briefs / per-story specs). The one load-bearing rationale (decoder single-parse-pass at Seam 3) was inlined intodocs/dev/engineering.mdfirst so nothing is lost.docs/.docs/superpowers/→ tool-neutralplanning/directory at repo root (planning/specs/,planning/plans/,planning/deferred-work.md). All renames viagit mvso history is preserved.docs/engineering.md→docs/dev/engineering.md; rootCONTRIBUTING.md→docs/dev/contributing.mdwith a thin rootCONTRIBUTING.mdstub preserving GitHub's "open a PR" UI integration.mkdocs.yml,.readthedocs.yaml,docs/requirements.txt,docs/index.md) published via Read the Docs, modeled onmodern-di's setup. Quick-Start + Development (Engineering Notes, Contributing) — user-guide content grows in follow-up PRs.modern-pythonorg pattern, links to the new docs site.src/layout stays.Test Plan
just lint-ciexits 0 (no source changes — should be unaffected)just testexits 0, 295 passed, 100% coverage maintaineduv run --with mkdocs --with mkdocs-material mkdocs build --strictexits 0 with zero broken-link warningsgit log --follow planning/specs/2026-06-01-auth-coercion-design.mdshows pre-rename history (verifiesgit mvpreserved history across the move)grep -rn "docs/archive\|docs/superpowers/\|docs/engineering\.md\|docs/deferred-work\.md" docs/ CLAUDE.md README.mdreturns zero hits in the published treedocs/dev/engineering.mdsection 3 Seam 3 contains the inlined decoder rationale (maxsize=1024cache on_get_adapterfactory,msgspec.json.decodealternative) — confirms the archive deletion lost no load-bearing rationalePost-merge follow-ups (out of scope for this PR)
mainafter merge.httpware.readthedocs.iosubdomain. If unavailable, updatesite_urlinmkdocs.ymland the README docs link.Notes on accepted deviations
planning/(specifically2026-05-31-bmad-to-superpowers-transition-*.mdand2026-05-31-release-0.1.0-prep-*.md) intentionally retain references todocs/archive/anddocs/superpowers/. These are past-tense narrative describing what those earlier transitions did; rewriting them would falsify the historical record. They are not user-visible (not part of the mkdocs site) and not load-bearing.Spec: `planning/specs/2026-06-02-docs-reorg-and-mkdocs-design.md`
Plan: `planning/plans/2026-06-02-docs-reorg-and-mkdocs-plan.md`