Review internal documentation (*.md files) against the current codebase state and propose updates for outdated or incorrect information.
Review internal documentation files against the actual codebase state and propose fixes for outdated, incorrect, or missing information.
Priority files (most likely to contain codebase-specific instructions):
**/AGENTS.md - AI agent instructions**/README.md - Package/directory documentation.claude/skills/*/SKILL.md - Skill definitions.claude/agents/*.md - Subagent definitionswiki/**/*.md - Developer wikiCONTRIBUTING.md - Contributor guideFiles to skip (synced copies, updated separately):
.github/copilot-instructions.md.github/instructions/*.md.cursor/rules/*.mdcmake help).github/workflows/AGENTS.md reflects actual workflow filesCONTRIBUTING.md skill/agent overview matches .claude/skills/*/ and .claude/agents/# Check path exists: test -e path && echo ok || echo missing
# Check URL reachable: curl -sI -o /dev/null -w "%{http_code}" <url>
| Tool | Config file |
|---|---|
| TypeScript, React, Vite, Vitest, ESLint, oxfmt, Emotion | frontend/package.json |
| Yarn | frontend/package.json (packageManager field) |
| Python, Ruff, mypy, pytest | pyproject.toml |
| Node.js | .nvmrc |
| Type | Description |
|---|---|
| OUTDATED | Info no longer accurate (old make targets, renamed files) |
| INCORRECT | Factually wrong (wrong paths, invalid commands) |
| VERSION_MISMATCH | Documented version differs from actual |
| MISSING | Important info not documented |
| BROKEN_LINK | Links to non-existent resources |
| INCONSISTENT | Conflicts with other docs |
List all issues and let the user choose which to fix:
Documentation Review: {SCOPE}
═══════════════════════════════════════════════════════════════
Found {N} issues across {M} files:
1. [OUTDATED] AGENTS.md:42
Current: `make python-check`
Actual: Command renamed to `make python-lint`
2. [INCORRECT] wiki/testing.md:15
Current: Tests in `lib/tests/unit/`
Actual: Path is `lib/tests/streamlit/`
3. [BROKEN_LINK] CONTRIBUTING.md:88
Current: Link to `./docs/setup.md`
Actual: File does not exist
Which issues should I fix?
Recommended: "all"
Options: "1" | "1,2,3" | "all" | "skip 3"
/checking-changes to validateExample summary:
Fixed 3 of 4 issues:
- #1 [OUTDATED]: Updated make command in AGENTS.md
- #2 [INCORRECT]: Fixed test path in wiki/testing.md
- #3 [BROKEN_LINK]: Removed dead link in CONTRIBUTING.md
- #4 [INCONSISTENT]: Skipped - requires manual verification
Files modified:
AGENTS.md | 2 +-
wiki/testing.md | 4 ++--
CONTRIBUTING.md | 1 -