Update Documentation References
CommunityKeep docs correct after code changes.
Software Engineering#documentation#developer workflow#GitHub CLI#frontmatter parsing#diff evaluation#API reference updates#pull request analysis
AuthorHabibTorjmen
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Documentation can become outdated when referenced source files change, causing readers to rely on incorrect APIs, types, examples, or behavior.
Core Features & Use Cases
- PR-driven reference analysis: Extracts PR number, title, and changed source references from the dispatch prompt to determine what needs review.
- Impact-aware documentation updates: Compares documentation frontmatter reference mappings against diffs to decide whether content truly changed.
- Minimal, style-preserving edits: Applies only the precise documentation changes needed for accuracy, including updating examples when APIs differ.
- Team-ready reporting: Creates a follow-up PR when changes are required and reports results to the provided Slack thread, including diffs if PR creation fails.
Quick Start
Ask the skill to update documentation references for the provided PR by analyzing the code diffs, validating the referenced mappings in doc frontmatter, and updating only the docs that require content changes.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: Update Documentation References Download link: https://github.com/HabibTorjmen/Blockchain/archive/main.zip#update-documentation-references Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.