Skip to content

docs: remove the planning directory - #448

Merged
retr0h merged 1 commit into
mainfrom
docs/remove-plans
Aug 16, 2026
Merged

docs: remove the planning directory#448
retr0h merged 1 commit into
mainfrom
docs/remove-plans

Conversation

@retr0h

@retr0h retr0h commented Aug 16, 2026

Copy link
Copy Markdown
Collaborator

Implements specify-documentation-homes tasks 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 — removing POST /job in favour of domain endpoints
  • 2026-03-11-container-runtime-design.md — the pluggable runtime driver interface
  • 2026-03-13-container-runtime-rename-design.md
  • 2026-03-03-agent-facts-design.md
  • 2026-03-06-file-deploy-template-design.md
  • 2026-02-27-node-resource-api-restructuring.md

Each 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 of github.com/golang/mock, which correct-documentation-drift deliberately left in place because this change removes the directory wholesale. Both counts are now zero.

Verification

  • just docusaurus-build succeeds — the site's content root is docs/docs/, so docs/plans/ was formatted but never built
  • just docusaurus-fmt-check and just md-fmt-check pass

Task 4.4 — noting in CONTRIBUTING.md that design records are changes — cannot be done here yet: osapi has no root CONTRIBUTING.md until standardize-repository-layout task 4.5 creates it.

🤖 Generated with Claude Code

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>
@retr0h
retr0h merged commit 65d8de4 into main Aug 16, 2026
10 checks passed
@retr0h
retr0h deleted the docs/remove-plans branch August 16, 2026 06:02
@codecov

codecov Bot commented Aug 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d802e81...6c1d261. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant