Skip to content

docs: remove internal planning and draft documents - #63

Merged
rominf merged 1 commit into
mainfrom
remove-internal-planning-docs
Jun 29, 2026
Merged

docs: remove internal planning and draft documents#63
rominf merged 1 commit into
mainfrom
remove-internal-planning-docs

Conversation

@rominf

@rominf rominf commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

What

Removes a set of internal development planning notes, superseded implementation drafts, and status-tracking documents that are not user- or contributor-facing and don't belong in the public repository.

Deleted:

  • plans/ — implementation plans, the PyTorch engine spec, and linting-strategy notes
  • docs/codex-vendoring-plan.md, docs/upstream-codex-sync.md — superseded; the vendored tree they described was already removed
  • docs/current-tui-therock-correction-plan.md — a completed correction pass kept only as history
  • docs/dash-parity-map.md, docs/dash-parity-checklist.md, docs/implementation-completion-audit.md, docs/tui-retirement-checklist.md — internal status/tracking matrices
  • ROADMAP.md — internal work-tracking, not a public roadmap

Scrubbed:

  • docs/wsl.md — removed the first-person "Current Host Finding" section describing one developer's machine; the rest of the WSL guide is unchanged.

Reference cleanup (so nothing dangles): dropped the /plans/** rule from .gitattributes, the plans/ section from MANIFEST.md, an example-file pointer in AGENTS.md, and a few stale source-comment references in apps/rocm/src/main.rs and crates/rocm-core/src/{diagnose,examine,fix}.rs.

Why

These documents reflect the internal development process rather than the product. They add noise for external readers and risk going stale. Genuine outstanding work they described is tracked separately in the issue tracker.

Notes

  • No code or behavior change — the only source edits are comment-only and remove pointers to deleted files.
  • Verified no remaining references to any removed file across the tree, CI workflows, and docs.

These files were internal development planning notes, superseded
implementation drafts, and status-tracking matrices created during
development. They are not user- or contributor-facing documentation and
do not belong in the public repository.

Removed:
- plans/ (implementation plans, engine spec, linting-strategy notes)
- docs/codex-vendoring-plan.md, docs/upstream-codex-sync.md (superseded;
  the vendored tree they described was already removed)
- docs/current-tui-therock-correction-plan.md (completed correction pass)
- docs/dash-parity-map.md, docs/dash-parity-checklist.md,
  docs/implementation-completion-audit.md,
  docs/tui-retirement-checklist.md (internal status trackers)
- ROADMAP.md (internal work-tracking, not a public roadmap)

Also scrub the first-person "Current Host Finding" section from
docs/wsl.md, and drop now-dangling references to the removed files in
.gitattributes, AGENTS.md, MANIFEST.md, and a few source-comment
pointers. Genuine outstanding work described by these docs is tracked
separately in the issue tracker.

Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
@rominf
rominf requested review from juhovainio and volen-silo June 29, 2026 10:41

@juhovainio juhovainio left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@rominf
rominf added this pull request to the merge queue Jun 29, 2026
Merged via the queue into main with commit 8922d26 Jun 29, 2026
8 checks passed
@rominf
rominf deleted the remove-internal-planning-docs branch June 29, 2026 13:54
michaelroy-amd added a commit that referenced this pull request Jun 30, 2026
Resolve conflicts after main advanced (PR #63 cleanup + reroute):
- apps/rocm/src/main.rs: keep PR #62's minimal launcher front door for bare
  `rocm` (dash::run_launcher); drop the dangling docs/tui-retirement-checklist.md
  reference (deleted on main).
- docs/dash-parity-checklist.md, docs/dash-parity-map.md: accept main's
  deletion (PR #63 removed these tracker docs); the Phase 4 test-name updates
  to them are moot.

Full gate green post-merge: fmt, build, clippy -D warnings, single-thread tests.

Signed-off-by: Michael Roy <michael.roy@amd.com>
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.

2 participants