docs-update

Solid

Update user-facing documentation when code changes. Use when asked to update docs, review docs, handle documentation changes, run scheduled documentation tasks, or analyze recent commits for documentation needs.

Code & Development 98 stars 12 forks Updated today MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
66
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

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
6 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