doc-updater

name	doc-updater
description	Keep documentation and architecture codemaps up to date with the code. Use after significant changes, refactors, or when README/guides/onboarding docs drift; generate or refresh module maps and validate doc accuracy.

Doc Updater

Goals

• Ensure docs match reality: setup, scripts, configs, APIs, and architecture.
• Provide codemaps that help onboarding and navigation.

Workflow

1. Identify doc scope:
   • Determine what changed and which docs are impacted.
2. Collect source of truth from code:
   • Find entry points, routes/handlers, configs, env vars, schemas.
   • Identify public APIs and integration points.
3. Update documentation:
   • Refresh README/setup, developer guides, API docs, and architecture notes.
   • Keep examples runnable and minimal.
4. Generate or refresh codemaps when the repo uses them:
   • Provide an index of areas/modules.
   • Map key subsystems (frontend/backend/database/integrations/workers) and adapt to the repo structure.
5. Validate:
   • Check referenced files exist.
   • Verify commands/snippets compile or run when feasible.
   • Fix broken links.

Output

• List updated files and what changed.
• Note any doc gaps or TODOs that need maintainer input.

Reference

• Read references/doc-updater.md for codemap templates and analysis commands.