Files
PDFToMD/.codex/commands/review-project-docs.md
T
2026-05-14 10:16:59 +09:00

1.5 KiB

description, argument-hint, allowed-tools
description argument-hint allowed-tools
Review core project documents for consistency with fixed decisions
scope
Read
Glob
Grep
Bash
Edit

/review-project-docs

Review project documents for contradictions, stale decisions, and missing constraints.

Arguments

The user invoked this command with: $ARGUMENTS

Workflow

  1. Read PLAN.md and PROGRESS.md.
  2. Read docs/WORKARCHIVE.md when reviewing completed-work history, prior verification, or sample conversion evidence.
  3. Read the requested document scope, defaulting to AGENTS.md, PRD.md, ARCHITECTURE.md, docs/V1IMPLEMENTATIONPLAN.md, docs/WORKARCHIVE.md, and docs/KNOWLEDGEBASE.md.
  4. Check for contradictions against fixed decisions: MinerU 3.1.0 only, local-only, direct CLI execution, CLI-internal temporary local mineru-api allowed, no --api-url or remote API path, Python 3.12, uv, Obsidian Markdown, no public metadata JSON for new conversions, one <stem>_report.md, and any UI launcher invoking the existing pdf2md CLI rather than MinerU directly.
  5. Report findings first with file and line references.
  6. If edits are requested, make only surgical documentation changes and update PROGRESS.md.

Guardrails

  • Do not add speculative features, alternate engines, hosted web apps, cloud OCR, or manual review queues. A thin local UI launcher is allowed only when it follows docs/UI_RESEARCH.md, docs/Sprints/SPRINT12CONTRACT.md, and the relevant docs/superpowers/ UI design or plan.
  • Do not rewrite unrelated prose while fixing one inconsistency.