update-docs

Audit static context files and update project documentation using git and grep.

1|1|Updated Mar 10, 2013

Search Tags:#git integration #code documentation #codebase synchronization #automated updates #static context audit

Ready to run

npx skills add https://github.com/aaronlord/.dotfiles --skill update-docs-aaronlord

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/aaronlord/.dotfiles/tree/main/pi/skills/update-docs
Command: npx skills add https://github.com/aaronlord/.dotfiles --skill update-docs-aaronlord

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, grep, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that project documentation remains up-to-date with the latest codebase changes, reducing the risk of outdated information and improving collaboration.

Core Features & Use Cases

Automated Documentation Updates: Updates documentation based on codebase changes, conventions, or specific topics.
Static Context Audit: Audits static context files for staleness, dead references, duplication, and bloat.
Topic-Specific Updates: Updates specific documentation files based on user input or automated analysis.
Use Case: Use the /update-docs command with a topic hint to update documentation related to a specific change or convention.

Quick Start

Run /update-docs how we write command handlers to update documentation for command handler conventions.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I keep project documentation in sync with codebase changes?▼

To keep project documentation in sync with codebase changes, you can use automated updates that analyze your code and reflect new conventions in your docs. This reduces the risk of outdated information and improves team collaboration.

What is the best way to audit static context files for staleness and bloat?▼

Auditing static context files for staleness and bloat involves scanning your project files to identify dead references and duplication. This process ensures your documentation remains concise and accurately reflects the current codebase state.

How do I update documentation for a specific code convention or topic?▼

You can update documentation for a specific code convention by providing a topic hint. The system uses this input to perform automated analysis and update only the relevant documentation files for that particular change.

Do I need git and grep installed to automate documentation updates?▼

Yes, you need git and grep installed to automate documentation updates. These dependencies are required for code analysis, allowing the system to audit static context and synchronize your project documentation with codebase changes.

Can I use this tool to find dead references in my project documentation?▼

Yes, you can use this tool to find dead references in your project documentation. It audits static context files specifically to detect staleness, dead references, duplication, and bloat, keeping your documentation accurate.