mindroom: Skill for Claude Code

Review documentation for accuracy, completeness, and consistency. Focus on things that require judgment—automated checks handle the rest.

What's Already Automated

Don't waste time on these—CI and pre-commit hooks handle them:

• README CLI output: markdown-code-runner regenerates CLI help blocks via docs/run_markdown_code_runner.py
• Linting/formatting: Handled by pre-commit

What This Review Is For

Focus on things that require judgment:

1. Accuracy: Does the documentation match what the code actually does?
2. Completeness: Are there undocumented features, options, or behaviors?
3. Clarity: Would a new user understand this? Are examples realistic?
4. Consistency: Do different docs contradict each other?
5. Freshness: Has the code changed in ways the docs don't reflect?

Review Process

1. Check Recent Changes

# What changed recently that might need doc updates?
git log --oneline -20 | grep -iE "feat|fix|add|remove|change|option"

# What code files changed?
git diff --name-only HEAD~20 | grep "\.py$"

Look for new features, changed defaults, renamed options, or removed functionality.

2. Verify Configuration Docs Against Code

Compare docs under docs/configuration/ against the Pydantic models in the src/mindroom/config/ package, whose root model is in src/mindroom/config/main.py. Do not rely on a fixed list of files; discover what exists in both locations and check they match.

# Find every config class declaration, including indirect Pydantic subclasses
rg -n "^class " src/mindroom/config

# Find all config doc files
ls docs/configuration/

Trace inheritance for every discovered class instead of assuming each Pydantic model directly subclasses BaseModel.

Check:

• All config keys documented, types and defaults match code
• No models exist without corresponding docs (or vice versa)
• Example YAML would actually work

3. Verify Architecture Docs Against Source

# What source files actually exist?
git ls-files "src/mindroom/**/*.py"