tmpl/multi-agent-mux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs): remove obsolete root planning docs per 3-agent markdown audit

Browse Source 
- 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:
Godopu
2026-07-11 08:50:30 +09:00
parent 1c2ce0953d
commit 9b831932b0
8 changed files with 295 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.agents/reports/canary-projects-multi-agent-mux-reviewer-cline/report-markdown-analysis.md
+91
View File
@@ -0,0 +1,91 @@
# Workspace Root Markdown Files Analysis Report
- **Reviewer**: Reviewer Cline (`canary-projects-multi-agent-mux-reviewer-cline`, role: reviewer)
- **Date**: 2026-07-11
- **Brief**: `.mam/reports/brief-root-markdowns.md`
- **Scope**: 7 root markdown files — purpose, status, KEEP/DELETE verdict
---
## Summary Verdict Table
| # | File | Purpose | Status | Verdict |
|---|------|---------|--------|---------|
| 1 | `task.md` | Task checklist for "deploy URL parameterization" (Rev.1) | **Obsolete** — work shipped in commit `6408f4a`, checkboxes never updated | **DELETE** |
| 2 | `implementation_plan.md` | Implementation plan for "deploy URL parameterization" (Rev.1) | **Obsolete** — superseded by shipped commit `6408f4a` | **DELETE** |
| 3 | `BOOTSTRAP.md` | Setup & verification guide for new agents | **Active** — referenced by `README.md`, in `deploy/install.sh` doc-allowlist | **KEEP** |
| 4 | `FUTURE_WORKS.ko.md` | Korean roadmap of pending improvement items | **Active** — open items FW-P1~P7/W1~W7/D2~D4; maintained KO mirror of `FUTURE_WORKS.md` | **KEEP** |
| 5 | `DONE.md` | Completed-tasks tracker (FW-01~FW-W3, verified 2026-06-21) | **Static historical record** — referenced by `FUTURE_WORKS.md`; in `deploy/install.sh` skip-list | **KEEP** |
| 6 | `session_isolation_discussion.md` | Rev.3 discussion doc for session ID isolation | **Superseded** — single source of truth moved to `implementation_plan.session_isolation.md`; work is DONE (reviewed PASS) | **DELETE** |
| 7 | `AGENTS.md` | Core behavioral guidelines for all agents | **Active & essential** — installed by `install_mam.sh`, referenced everywhere | **KEEP** |
---
## Detailed Analysis
### 1. `task.md` — DELETE ❌
- **Purpose**: Task checklist (Rev.1) for the "배포 스크립트 URL 파라미터화" (deploy URL parameterization) effort. References `implementation_plan.md` as its base document.
- **Current Status**: **Obsolete.** All checkboxes remain `[ ]` unchecked, but the work it describes **has been shipped**: commit `6408f4a feat(deploy): parameterize distribution URLs via MAM_*_URL env vars` implements exactly T1–T4 of this checklist. Verified in code:
- `deploy/install.sh:57` → `REPO_URL="${MAM_REPO_URL:-https://...}"` (T1 ✅)
- `deploy/install.sh:58` → `ARCHIVE_URL="${MAM_ARCHIVE_URL:-https://...}"` (T1 ✅)
- `deploy/update.sh:139` → `INSTALLER_URL="${MAM_INSTALLER_URL:-https://...}"` (T2 ✅)
- `.env.example:84-97` → all 3 variables documented (T3 ✅)
- The commit message matches the plan's §6 proposed commit message verbatim.
- **Verdict: DELETE.** Stale planning artifact for completed work. The checkboxes were never updated, leaving a misleading impression of incomplete work. The shipped commit + `.env.example` are the real records of completion.
- **Pre-deletion check**: no inbound references from `README.md`, `deploy/install.sh`, or any active code. Safe to delete. (`.agents/multi_agent_workflow.md` mentions `task.md` generically as a workflow convention, not this specific file.)
### 2. `implementation_plan.md` — DELETE ❌
- **Purpose**: Implementation plan (Rev.1) for the same "deploy URL parameterization" effort, by Planner Agent dated 2026-07-09, status "Draft (사용자 승인 대기)".
- **Current Status**: **Obsolete.** Same as `task.md` — the plan was executed and shipped in commit `6408f4a`. The plan's §3.1/§3.2 code snippets match the current `deploy/install.sh`/`update.sh` line-for-line. Its status line still says "Draft (사용자 승인 대기)" which is no longer accurate.
- **Verdict: DELETE.** Stale planning artifact for completed work, paired with `task.md`. The shipped commit is the authoritative record.
- **Pre-deletion check**: no inbound references from `README.md` or active code. The only cross-reference is from `task.md` (also being deleted). Safe to delete.
### 3. `BOOTSTRAP.md` — KEEP ✅
- **Purpose**: Setup & initialization guide for new agents/developers adopting the MAM workflow — scaffolding overview, `.env` configuration, directory/security audit, and bootstrap verification tests.
- **Current Status**: **Active.** Referenced by `README.md:177` (root file-tree listing) and `README.md:186` ("For detailed setup instructions, please consult the **[BOOTSTRAP.md](./BOOTSTRAP.md)** file"). Listed in `deploy/install.sh:131` doc-allowlist (`MESSAGING.md BOOTSTRAP.md BOOTSTRAP.ko.md AGENTS.md`) — intentionally shipped to installed targets. Has a Korean mirror `BOOTSTRAP.ko.md` (same bilingual convention as `MULTI_AGENT_RULES.md`/`.ko.md`).
- **Verdict: KEEP.** Active onboarding document, referenced from two authoritative surfaces (README, installer), part of the shipped doc set.
### 4. `FUTURE_WORKS.ko.md` — KEEP ✅
- **Purpose**: Korean-language roadmap tracking pending improvement candidates (portability, concurrency, workflow, deployment hardening).
- **Current Status**: **Active.** Contains open items: FW-P1~P7, FW-W1~W7, FW-D2~D4 (all unchecked). Last updated 2026-06-24. One item struck through as resolved (FW-D1, 2026-06-24). This is the maintained Korean mirror of `FUTURE_WORKS.md` (same timestamp 2026-06-26 21:27, parallel bilingual convention) — NOT a stale backup.
- **Verdict: KEEP.** Living roadmap document with open work items; part of the repo's bilingual doc convention.
- **Note**: the header says "완료된 항목은 `DONE.ko.md`를 참조" — `DONE.ko.md` exists, so the cross-reference is valid.
### 5. `DONE.md` — KEEP ✅
- **Purpose**: Completed-tasks tracker recording FW-01 ~ FW-16, FW-L1~L3, FW-N1~N7, FW-W3 (28 items), verified by three agents (agy-new, agy-existing, claude-existing) on 2026-06-21.
- **Current Status**: **Static historical record.** All items complete and verified — this is a closed ledger, not a stale plan. Referenced by `FUTURE_WORKS.md:4` ("For completed items, see `DONE.md`") as the completion counterpart to the roadmap. Explicitly named in `deploy/install.sh:130` as a dev-doc intentionally **skipped** during install ("We skip dev-specific docs like README.md, DONE.md, and FUTURE_WORKS.md").
- **Verdict: KEEP.** Not an obsolete plan — a permanent audit record of what was done, cross-referenced by the active roadmap. Deleting it would orphan `FUTURE_WORKS.md`'s "see DONE.md" pointer and lose the verification history (which agents verified what, with which commit SHAs).
### 6. `session_isolation_discussion.md` — DELETE ❌
- **Purpose**: Rev.3 "단일 격리 디렉터리 통합본" — the integrated discussion/design doc for session ID isolation, consolidating earlier L1/L2 hybrid drafts.
- **Current Status**: **Superseded.** The single source of truth moved to `implementation_plan.session_isolation.md` (Rev.3), which lists this file as "관련 자료" (related material) — i.e., the dedicated plan is canonical, the discussion is the predecessor. The implementation is **DONE and reviewed PASS** (I verified this in my prior session-isolation review: commits `768cfe5`, `dad99f5`; T1–T6 + RK2 + T6 all PASS). The file's §5 still says "⏭️ 승인에 따라 Phase 0... 착수합니다" (proceeding to Phase 0), but Phase 0–4 are all complete.
- **Verdict: DELETE.** Superseded discussion draft. The canonical design lives in `implementation_plan.session_isolation.md`, task tracking in `task.session_isolation.md`, and the completed implementation in the codebase + my PASS review report. Keeping it creates a stale duplicate source of truth that could mislead future agents into thinking the work is still in progress.
- **Pre-deletion check**: inbound references exist only from historical reviewer briefs under `.agents/reports/.../brief-isolation-review.md` (audit trail, already completed) and from `implementation_plan.session_isolation.md`/`task.session_isolation.md` (which link to it as "관련 자료" for historical provenance — those dedicated docs are self-sufficient). No active code or `README.md` references it. Safe to delete; the audit trail in `.agents/reports/` preserves the review history.
### 7. `AGENTS.md` — KEEP ✅
- **Purpose**: Core behavioral guidelines for all LLM coding agents (Think Before Coding, Simplicity First, Surgical Changes, Goal-Driven Execution). The repo's primary agent-behavior contract.
- **Current Status**: **Active & essential.** Referenced by `MULTI_AGENT_RULES.md` note, `BOOTSTRAP.md:184` (onboarding points agents to it), `install_mam.sh` (copies it to target project roots with marker-injection protection). It's the first file any agent is instructed to read.
- **Verdict: KEEP.** Foundational, actively enforced, non-negotiable.
---
## Deletion Risk Assessment (for the 3 DELETE candidates)
| File | Inbound refs from active code/README? | Inbound refs from audit trail only? | Safe to delete? |
|------|--------------------------------------|-------------------------------------|-----------------|
| `task.md` | None (only `implementation_plan.md`, also being deleted) | No | ✅ Yes |
| `implementation_plan.md` | None (only `task.md`, also being deleted) | No | ✅ Yes |
| `session_isolation_discussion.md` | None from active code/README | Yes (`implementation_plan.session_isolation.md`, `task.session_isolation.md`, reviewer briefs) | ✅ Yes — audit trail preserved in `.agents/reports/`; the dedicated plan is self-sufficient |
**Recommendation**: Delete the 3 files in a single atomic commit, e.g. `chore(docs): remove obsolete completed-plan and superseded discussion drafts`. The deletion is safe — no active code or README references them, and the audit trail (review reports, shipped commits, dedicated plan docs) fully preserves the history.
---
## Final Statement
Of the 7 root markdown files analyzed, **3 are safe to delete** (`task.md`, `implementation_plan.md`, `session_isolation_discussion.md`) — all are stale planning artifacts for work that has been completed, shipped, and reviewed PASS. The remaining **4 should be kept** (`BOOTSTRAP.md`, `FUTURE_WORKS.ko.md`, `DONE.md`, `AGENTS.md`) — they are either active/referenced documents or permanent audit records. No active code paths or authoritative documentation reference the 3 deletion candidates; deleting them removes misleading "in-progress" signals without losing any history.