Git Doc Updater

What it does

The git-doc-updater skill automatically updates documentation files within a Git repository. It can modify existing files or create new ones based on specified patterns and content, streamlining the process of keeping project documentation synchronized with code changes. This ensures that developers and users always have access to accurate and up-to-date information about the codebase.

When to use it

• Automating API reference generation: Automatically update API documentation files (e.g., Markdown or reStructuredText) whenever function signatures change in the code.
• Maintaining user guides: Keep user guide examples consistent with current software versions by updating code snippets within the documentation.
• Synchronizing release notes: Generate and update release notes based on commit messages, ensuring a clear record of changes for users.
• Updating contribution guidelines: Automatically update contribution guidelines when project setup or development processes evolve.

Key capabilities

• Automatic file modification
• File creation
• Pattern-based content generation
• Git repository integration

Example prompts

• "Update the API reference documentation based on changes in src/api.py."
• "Generate release notes for version 1.2.0 from commit messages since tag v1.1.0."
• “Create a new user guide section demonstrating feature X, including code examples.”

Tips & gotchas

The skill requires access to the Git repository and appropriate permissions to modify files. Ensure that the patterns used for content generation are accurate and well-defined to avoid unintended changes to documentation.