docs-update
FeaturedUpdate docs when code changes — reviews commits and syncs user-facing documentation
Code & Development 117 stars
13 forks Updated today MIT
Install
Quality Score: 89/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# Documentation Bot
Automatically review code changes and update user-facing documentation to keep it synchronized with the codebase. Works across documentation platforms (Mintlify, Docusaurus, GitBook, Fumadocs, etc.) and supports both monorepo and multi-repo setups.
## Workflow
### 1. Identify Significant Code Changes
Determine which commits need documentation updates:
- Find the default branch
- Get recent commits (default: last 24 hours, or accept user-specified timeframe)
- Examine each commit's changes to understand what was modified
**Filter for significant changes:**
- New features or capabilities
- API changes (new endpoints, parameters, return values)
- Breaking changes
- New configuration options
- New CLI commands or flags
- Changes to user-facing behavior
**Skip documentation for:**
- Internal refactoring
- Test-only changes
- Minor bug fixes
- Typo corrections in code
- Performance optimizations without user impact
Be conservative: quality over quantity. When in doubt about significance, skip the update.
### 2. Analyze Documentation Context
**Locate documentation:**
- Check for documentation directory in current repo (monorepo pattern)
- Look for separate documentation repository in environment
**Identify documentation platform:**
Determine the platform by examining configuration files and directory structure (e.g., Mintlify, Docusaurus, GitBook, Fumadocs, or generic markdown).
**Understand documentation style:**
Read several existing documentatio...
Details
- Author
- jellydn
- Repository
- jellydn/my-ai-tools
- Created
- 7 months ago
- Last Updated
- today
- Language
- Shell
- License
- MIT
Integrates with
Bundled in these plugins
Similar Skills
Semantically similar based on skill content — not just same category
AI & Automation Listed
ami-docs-updater
Must be triggered when code changes affect documented APIs, interfaces, or public behavior. Identifies if codebase documentation exists and updates it to reflect the changes.
0 Updated today
AnaCataVC AI & Automation Solid
update-doc
Keep repository documentation synchronized with the latest code. Use when updating README/docs/codemaps after code changes, running docs-drift checks, or producing scoped evidence-backed doc patches for service/library/CLI/monorepo projects.
30 Updated 2 days ago
johnqtcg AI & Automation Solid
update-docs
Update all project documentation after code changes.
36 Updated 5 days ago
lbb00