docs: remove the planning directory - #448
Merged
Merged
Conversation
Design records belong in the corpus as changes, where a requirement and its reasoning stay attached to each other. A planning document kept beside the code goes stale the moment the code moves past it, with nothing to catch the drift. Git history retains every removed document. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #448 +/- ##
=======================================
Coverage 99.94% 99.94%
=======================================
Files 484 484
Lines 24935 24935
=======================================
Hits 24921 24921
Misses 14 14 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
Implements
specify-documentation-homestasks 4.1 and 4.2.Removes
docs/plans/— 70 documents. Design records belong in the corpus as changes, where a requirement and its reasoning stay attached to each other; a planning document kept beside the code goes stale the moment the code moves past it, with nothing to catch the drift.Reviewed before removal
Task 4.1 asked for a review first. Six carried decision rationale rather than step-by-step plans:
2026-03-09-unified-domain-endpoint-architecture-design.md— removingPOST /jobin favour of domain endpoints2026-03-11-container-runtime-design.md— the pluggable runtime driver interface2026-03-13-container-runtime-rename-design.md2026-03-03-agent-facts-design.md2026-03-06-file-deploy-template-design.md2026-02-27-node-resource-api-restructuring.mdEach describes architecture that is already built and already documented in
docs/docs/sidebar/architecture/. Nothing needed lifting into a change, and git history retains all seventy regardless.Side effect worth noting
docs/plans/held the last stale references in the repository — 16 broken relative links and 10 mentions ofgithub.com/golang/mock, whichcorrect-documentation-driftdeliberately left in place because this change removes the directory wholesale. Both counts are now zero.Verification
just docusaurus-buildsucceeds — the site's content root isdocs/docs/, sodocs/plans/was formatted but never builtjust docusaurus-fmt-checkandjust md-fmt-checkpassTask 4.4 — noting in
CONTRIBUTING.mdthat design records are changes — cannot be done here yet: osapi has no rootCONTRIBUTING.mduntilstandardize-repository-layouttask 4.5 creates it.🤖 Generated with Claude Code