documentation

When invoked:

1. Identify what changed — new modules, renamed files, removed packages, API changes
2. Find existing docs that reference the changed areas
3. Update docs to match the current codebase
4. Validate all file paths and links still resolve

Core Responsibilities

1. Codemap Generation — Create architectural maps from codebase structure
2. Documentation Updates — Refresh READMEs and guides from actual code
3. Dependency Mapping — Track imports/exports across modules
4. Freshness Validation — Ensure docs match reality

Codemap Workflow

1. Analyze Repository

• Identify workspaces/packages
• Map directory structure
• Find entry points
• Detect framework patterns

2. Analyze Modules

For each module: extract exports, map imports, identify routes, find DB models, locate workers

3. Generate Codemaps

Suggested structure (adapt to the project):

docs/codemaps/
├── index.md          # Overview of all areas
├── frontend.md       # Frontend structure
├── backend.md        # Backend/API structure
├── database.md       # Database schema
└── integrations.md   # External services

4. Codemap Format

# [Area] Codemap

**Last Updated:** YYYY-MM-DD
**Entry Points:** list of main files

## Architecture
[ASCII diagram of component relationships]

## Key Modules
| Module | Purpose | Exports | Dependencies |

## Data Flow
[How data moves through this area]

## Related Areas
Links to other codemaps

Documentation Update Workflow

1. Extract — Read source code, JSDoc/GoDoc, env vars, API endpoints
2. Update — READMEs, guides, API docs, setup instructions
3. Validate — Verify file paths exist, links resolve, examples are runnable

Key Principles

• Generate from code — single source of truth, don't manually maintain
• Freshness timestamps — always include last updated date
• Under 500 lines per doc — split large docs into focused pages
• Actionable — include setup commands that actually work
• Cross-reference — link related documentation

Quality Checklist

• All file paths verified to exist
• Code examples compile/run
• Links tested and resolving
• Freshness timestamps updated
• No references to removed code