Update documentation after code changes. Use when adding features, changing keybindings, modifying config options, or updating TUI behavior. Automatically finds and updates relevant documentation files (README, recipes, help text).
Streamline documentation updates when code changes are made. This skill helps identify what documentation needs updating and guides you through the process.
Use this skill after:
Analyze recent commits or current changes to identify documentation-impacting changes:
# Check uncommitted changes
git diff
# Check recent commits
git log -5 --oneline
git show <commit-sha>
# Check specific files
git diff HEAD~1 internal/tui/model.go
Look for:
Documentation files to check:
| File | Update When |
|---|---|
README.md | Keybindings, features, config options, CLI commands |
docs/recipes/*.md | Integration-specific changes |
| CLI help text | New commands, flags, or changed behavior |
Search commands:
# Find documentation files
find . -name "*.md" -not -path "./agent-deck/*" | head -20
# Search for specific content
grep -r "keybindings" README.md docs/
grep -r "Default keybindings" README.md
Default Keybindings (around line 311):
**Default keybindings:**
- `:` - Open command palette (when user commands configured)
- `v` - Toggle preview sidebar (shows tmux pane output)
- `r` - Recycle session
- `d` - Delete session
...
TUI Features (around line 303):
**Features:**
- Tree view of sessions grouped by repository
- Real-time terminal status monitoring (with tmux integration)
- Preview sidebar showing live tmux pane output (`v` to toggle)
...
Configuration Options (around line 238): Add new config fields to the table with type, default, and description.
CLI Reference (starting line 288): Add new commands or flags with descriptions and examples.
Update docs/recipes/tmux-integration.md when:
Check that documentation is accurate and complete:
# Search for old keybinding references
grep -r "old-key" README.md docs/
# Verify all new features are documented
grep -r "new-feature" README.md
# Check for consistency
grep -rn "keybindings" README.md
Commit documentation changes separately from code changes:
git add README.md docs/
git commit -m "docs: describe what was updated
Detailed description of changes."
Change: Added v key to toggle preview sidebar
Documentation Updates:
v key to keybindings listCommit:
git add README.md
git commit -m "docs: add preview sidebar to TUI features and keybindings
Document the new 'v' key for toggling the tmux pane preview sidebar
in the default keybindings list and TUI features section."
Change: Added tui.preview_enabled config option
Documentation Updates:
Change: Added hive preview command
Documentation Updates:
Use this checklist for every documentation update:
Be Proactive:
Be Thorough:
Be Clear:
Keep Organized: