Description
Multiple documentation inconsistencies and stale references exist across the codebase:
Stale File References
agents-docs/MIGRATION.md lines 772, 785: Link to deleted QUICKSTART.md
agents-docs/VERSION.md lines 33, 49: Reference deleted QUICKSTART.md
scripts/pre-commit-hook.sh line 31: git add QUICKSTART.md
.github/workflows/version-propagation.yml line 36: Stages QUICKSTART.md
Wrong Package Manager
docs/SETUP.md lines 8, 16, 22: Uses npm instead of pnpm
plans/INDEX.md line 119: Recommends npm test instead of pnpm test
Version Inconsistencies
agents-docs/MIGRATION.md line 5: Badge shows version-0.2.4, VERSION says 0.1.0
CHANGELOG.md links: Point to your-org/your-project instead of d-oit/do-knowledge-studio
Duplicated Content
agents-docs/WORKFLOW.md lines 89-107: "Swarm Worktree Workflow" section duplicated from lines 73-87
Files to Remove
agents-docs/RUST.md: Header says "Remove this file if your project is not Rust" — it is not
agents-docs/SUCCESS_TEST.md: Leftover test artifact with no value
export/index.html: Unused stub file
Missing Documentation
- No API documentation for the Repository class
- No CLI usage guide in README
- No LLM provider setup guide
- No database schema documentation
- No export format documentation
.env.example missing documentation for resolver env vars
Plan Status Inconsistencies
plans/INDEX.md line 48: Says code quality "IN PROGRESS" but plan 02 marks all [x] complete
plans/03-core-implementation.md lines 87-90: Completion criteria still unchecked [ ]
Acceptance Criteria
Description
Multiple documentation inconsistencies and stale references exist across the codebase:
Stale File References
agents-docs/MIGRATION.mdlines 772, 785: Link to deletedQUICKSTART.mdagents-docs/VERSION.mdlines 33, 49: Reference deletedQUICKSTART.mdscripts/pre-commit-hook.shline 31:git add QUICKSTART.md.github/workflows/version-propagation.ymlline 36: StagesQUICKSTART.mdWrong Package Manager
docs/SETUP.mdlines 8, 16, 22: Usesnpminstead ofpnpmplans/INDEX.mdline 119: Recommendsnpm testinstead ofpnpm testVersion Inconsistencies
agents-docs/MIGRATION.mdline 5: Badge showsversion-0.2.4, VERSION says0.1.0CHANGELOG.mdlinks: Point toyour-org/your-projectinstead ofd-oit/do-knowledge-studioDuplicated Content
agents-docs/WORKFLOW.mdlines 89-107: "Swarm Worktree Workflow" section duplicated from lines 73-87Files to Remove
agents-docs/RUST.md: Header says "Remove this file if your project is not Rust" — it is notagents-docs/SUCCESS_TEST.md: Leftover test artifact with no valueexport/index.html: Unused stub fileMissing Documentation
.env.examplemissing documentation for resolver env varsPlan Status Inconsistencies
plans/INDEX.mdline 48: Says code quality "IN PROGRESS" but plan 02 marks all[x]completeplans/03-core-implementation.mdlines 87-90: Completion criteria still unchecked[ ]Acceptance Criteria
QUICKSTART.mdreferences removed or redirectednpmreferences changed topnpmRUST.mdandSUCCESS_TEST.mdremovedexport/index.htmlremoved or replaced.env.exampledocumented with all variables