chore(docs): remove obsolete root planning docs per 3-agent markdown audit
- Delete task.md / implementation_plan.md (deploy URL parameterization shipped in 6408f4a; checklists were stale) and session_isolation_discussion.md (superseded by implementation_plan.session_isolation.md; feature shipped and PASSed) - Remove the two inbound links to the deleted discussion doc - Add reviewer analysis reports and this cleanup plan under .agents/reports/
This commit is contained in:
+127
@@ -0,0 +1,127 @@
|
||||
# Root Markdown Cleanup Plan (Planner Claude — Final)
|
||||
|
||||
- **Planner**: Planner Claude (`canary-projects-multi-agent-mux-planner-claude`)
|
||||
- **Date**: 2026-07-11
|
||||
- **Brief**: `.mam/reports/brief-planner-cleanup.md`
|
||||
- **Inputs consolidated**:
|
||||
1. Reviewer Cline — `.agents/reports/canary-projects-multi-agent-mux-reviewer-cline/report-markdown-analysis.md`
|
||||
2. Creator Claude — `.agents/reports/canary-projects-multi-agent-mux-creator-claude/report-markdown-analysis-crosscheck.md`
|
||||
- **Executor**: Antigravity
|
||||
|
||||
---
|
||||
|
||||
## 1. Final Verdict Checklist (Consolidated)
|
||||
|
||||
Both reviewers agree on all 7 verdicts. The single discrepancy is *how* to delete #6, not *whether*.
|
||||
|
||||
| # | File | Cline | Creator Claude | **Final** |
|
||||
|---|------|-------|----------------|-----------|
|
||||
| 1 | `task.md` | DELETE | DELETE | ☑ **DELETE** |
|
||||
| 2 | `implementation_plan.md` | DELETE | DELETE | ☑ **DELETE** |
|
||||
| 3 | `BOOTSTRAP.md` | KEEP | KEEP | ☑ **KEEP** |
|
||||
| 4 | `FUTURE_WORKS.ko.md` | KEEP | KEEP | ☑ **KEEP** |
|
||||
| 5 | `DONE.md` | KEEP | KEEP | ☑ **KEEP** |
|
||||
| 6 | `session_isolation_discussion.md` | DELETE (standalone) | DELETE **+ inbound-link cleanup** | ☑ **DELETE + link cleanup** (Creator Claude's amendment adopted) |
|
||||
| 7 | `AGENTS.md` | KEEP | KEEP | ☑ **KEEP** |
|
||||
|
||||
**Discrepancy resolution (#6)**: Creator Claude's cross-check found two live tracked docs still linking to `session_isolation_discussion.md` (`implementation_plan.session_isolation.md:6`, `task.session_isolation.md:3`), which Cline's report missed. A standalone `git rm` would leave dangling links. **Decision: delete the file and surgically remove the two inbound link references in the same commit.** The broader option (archiving the entire session-isolation doc set — `Problem_Definition.md`, `implementation_plan.session_isolation.md`, `task.session_isolation.md`, `session_isolation_handover.md`) is **out of scope** for this plan: those four files were never analyzed under the brief's 7-file scope, so deleting them now would be an unauthorized scope expansion. They are listed in §4 as a recommended follow-up requiring separate GM authorization.
|
||||
|
||||
---
|
||||
|
||||
## 2. Impact Assessment
|
||||
|
||||
Verified by repo-wide grep (`--include='*.md'` plus `deploy/install.sh`, `scripts/install_mam.sh`):
|
||||
|
||||
| File to delete | Inbound references | Impact after this plan |
|
||||
|---|---|---|
|
||||
| `task.md` | Only from `implementation_plan.md` (deleted in same commit). `.agents/multi_agent_workflow.md` references the *filename convention* for future planning cycles, not this instance. | ✅ None |
|
||||
| `implementation_plan.md` | Only from `task.md:3` (deleted in same commit). | ✅ None |
|
||||
| `session_isolation_discussion.md` | **Live**: `implementation_plan.session_isolation.md:6`, `task.session_isolation.md:3` → **fixed by T2/T3 edits below**. **Historical** (briefs/reports under `.agents/reports/**`): intentionally left untouched — they are immutable audit records describing a past review of a then-existing file. | ✅ None after T2/T3 |
|
||||
|
||||
KEEP-file safety confirmed: `BOOTSTRAP.md` is in the deploy installer's doc allowlist (`deploy/install.sh:131`); `AGENTS.md` is copied by both installers (`deploy/install.sh:131`, `scripts/install_mam.sh:127,138`); `DONE.md` is linked from `FUTURE_WORKS.md:4`; `FUTURE_WORKS.ko.md` is the active backlog mirror. None are touched.
|
||||
|
||||
No documentation build system exists in this repo (no mkdocs/sphinx config); link integrity is the only build-type concern.
|
||||
|
||||
**Precondition check (resolved)**: the previously flagged uncommitted `.gitignore` change (adding `.agents/reports`) is no longer present — `git diff` is clean. No blocker remains. The only untracked files are the two reviewer reports, which must be committed per the durable-reports convention (`.agents/MULTI_AGENT_RULES.md`).
|
||||
|
||||
---
|
||||
|
||||
## 3. Execution Instructions (for Antigravity)
|
||||
|
||||
Run from the repo root. All steps are non-interactive. **Do not use `rm` — the three files are git-tracked; use `git rm` so the deletion is staged.**
|
||||
|
||||
### T0 — Preflight (abort if it fails)
|
||||
```bash
|
||||
cd /home/godopu16/PuKi/laa/canary_projects/multi-agent-mux
|
||||
git diff --quiet && git diff --cached --quiet || { echo "ABORT: dirty tree"; exit 1; }
|
||||
```
|
||||
(Untracked files are fine and expected: the two reviewer reports.)
|
||||
|
||||
### T1 — Delete the three files
|
||||
```bash
|
||||
git rm task.md implementation_plan.md session_isolation_discussion.md
|
||||
```
|
||||
|
||||
### T2 — Remove the inbound link in `implementation_plan.session_isolation.md` (line 6)
|
||||
Replace the line:
|
||||
```
|
||||
- **관련 자료**: [Problem_Definition.md](Problem_Definition.md), [session_isolation_discussion.md](session_isolation_discussion.md)
|
||||
```
|
||||
with:
|
||||
```
|
||||
- **관련 자료**: [Problem_Definition.md](Problem_Definition.md)
|
||||
```
|
||||
|
||||
### T3 — Remove the inbound link in `task.session_isolation.md` (line 3)
|
||||
Replace the line:
|
||||
```
|
||||
> 기준 문서: [implementation_plan.session_isolation.md](implementation_plan.session_isolation.md) (Rev.3) / [session_isolation_discussion.md](session_isolation_discussion.md)
|
||||
```
|
||||
with:
|
||||
```
|
||||
> 기준 문서: [implementation_plan.session_isolation.md](implementation_plan.session_isolation.md) (Rev.3)
|
||||
```
|
||||
**Surgical constraint (AGENTS.md §3): change only these two lines. No other edits to either file.**
|
||||
|
||||
### T4 — Verify no dangling references remain outside the immutable report archive
|
||||
```bash
|
||||
grep -rn --include='*.md' 'session_isolation_discussion\|\](task\.md)\|\](implementation_plan\.md)' \
|
||||
--exclude-dir=.git . | grep -v '^\./\.agents/reports/' | grep -v '^\./\.mam/'
|
||||
```
|
||||
**Expected output: empty** (exit code 1). Any hit = stop and report back.
|
||||
|
||||
### T5 — Stage the analysis reports and this plan, then commit (single atomic commit)
|
||||
```bash
|
||||
git add .agents/reports/canary-projects-multi-agent-mux-reviewer-cline/report-markdown-analysis.md \
|
||||
.agents/reports/canary-projects-multi-agent-mux-creator-claude/report-markdown-analysis-crosscheck.md \
|
||||
.agents/reports/canary-projects-multi-agent-mux-planner-claude/report-cleanup-plan.md \
|
||||
implementation_plan.session_isolation.md task.session_isolation.md
|
||||
git commit -m "chore(docs): remove obsolete root planning docs per 3-agent markdown audit
|
||||
|
||||
- Delete task.md / implementation_plan.md (deploy URL parameterization
|
||||
shipped in 6408f4a; checklists were stale) and
|
||||
session_isolation_discussion.md (superseded by
|
||||
implementation_plan.session_isolation.md; feature shipped and PASSed)
|
||||
- Remove the two inbound links to the deleted discussion doc
|
||||
- Add reviewer analysis reports and this cleanup plan under .agents/reports/"
|
||||
```
|
||||
|
||||
### T6 — Post-commit sanity
|
||||
```bash
|
||||
git status --short # expected: empty
|
||||
bash -n scripts/install_mam.sh deploy/install.sh # unchanged, but cheap regression guard
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Out-of-Scope Follow-Ups (require separate GM authorization)
|
||||
|
||||
1. **Session-isolation doc set retirement**: `Problem_Definition.md`, `implementation_plan.session_isolation.md`, `task.session_isolation.md`, `session_isolation_handover.md` are also completed-work artifacts. Recommend a follow-up brief to analyze and disposition them as one unit (the durable outcomes already live in `.agents/reports/*/report-isolation-review.md` and git history).
|
||||
2. **`.ko.md` twins**: verdicts here extend naturally to counterparts (`DONE.ko.md`, `FUTURE_WORKS.md`, `BOOTSTRAP.ko.md`) — all KEEP; no action.
|
||||
3. The root still holds 18→15 markdown files after this cleanup; a future pass may consider moving design docs to a `docs/` subtree, but that is a layout decision, not cleanup.
|
||||
|
||||
---
|
||||
|
||||
## Final Authorization
|
||||
|
||||
**Plan status: APPROVED for execution** by Antigravity exactly as written in §3. Deviations (non-empty T4 output, preflight failure, edit-line mismatch) must halt execution and be reported back to the Planner.
|
||||
Reference in New Issue
Block a user