update-docs

Name: update-docs
Availability: InStock
Author: Adam

Review Git branch changes to identify MkDocs documentation updates for Python projects.

11|Updated Mar 16, 2024

Search Tags:#developer tools #code review #documentation #technical writing #docs #mkdocs

Ready to run

npx skills add https://github.com/adamfilli/happy-simulator --skill update-docs-adamfilli

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/adamfilli/happy-simulator/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/adamfilli/happy-simulator --skill update-docs-adamfilli

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of reviewing code changes and updating the project's documentation to accurately reflect new or modified functionality, ensuring documentation remains current and useful.

Core Features & Use Cases

Change Identification: Compares current branch changes against the main branch to pinpoint code modifications.
Documentation Mapping: Guides users on which documentation sections (guides, API reference, examples) need updates based on the nature of code changes.
Verification: Provides commands to build the documentation locally and check for errors.
Use Case: After adding a new feature to the happysimulator library, this Skill helps you identify which Markdown files in the docs/ directory need to be updated to explain the new feature and its usage.

Quick Start

Run the update-docs skill to review changes and update documentation for the current branch.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I keep MkDocs documentation in sync with code changes on a feature branch?▼

To keep MkDocs documentation in sync, review code changes on your feature branch against the main branch to identify necessary updates for guides, API reference pages, and example galleries based on new modules or modified APIs.

What is the best way to update Python project documentation after adding a new feature?▼

The best way to update Python project documentation is to map code modifications to specific documentation sections, guiding you on which Markdown files in the docs directory need updates to accurately explain the new functionality and usage.

Do I need local Git repository access to identify necessary documentation updates?▼

Yes, you need local Git repository access to compare current branch changes against the main branch, pinpoint code modifications, and determine which documentation sections require corresponding updates.

How can I verify that my updated MkDocs documentation builds without errors?▼

You can verify updated MkDocs documentation by running local build commands provided during the review process, which check for errors and ensure your guides and API references compile correctly after modifications.

When should I update API reference pages for a Python project using MkDocs?▼

You should update API reference pages when code changes introduce new modules, features, or API modifications, ensuring that the technical documentation accurately reflects the current state of the codebase.