docs-after-change

Updates documentation for changed files across the entire system.

45|13|Updated May 11, 2023
One-click install
npx skills add https://github.com/Open-Earth-Foundation/CityCatalyst --skill docs-after-change
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-after-change
Source: https://github.com/Open-Earth-Foundation/CityCatalyst/tree/main/.cursor/skills/docs-after-change
Command: npx skills add https://github.com/Open-Earth-Foundation/CityCatalyst --skill docs-after-change

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures repository documentation stays accurate after code changes by validating and updating docstrings, READMEs, and architecture notes.

Core Features & Use Cases

  • Validate and refresh docstrings in touched runnable scripts and related modules.
  • Update READMEs that document entrypoints, setup, environment variables, and outputs.
  • Update architecture/docs (e.g., architecture.md) when the code structure or data flow changes.

Quick Start

Run the docs-after-change skill after making code changes to align documentation with the new behavior and structure.

Frequently Asked Questions about docs-after-change

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

FAQPage Schema
How do I keep Python docstrings and architecture docs updated after code changes?

To keep documentation updated after code changes, you can validate and refresh Python docstrings, READMEs, and architecture notes by analyzing touched modules and applying non-invasive edits to align with new behavior.

What is the best way to sync README files when modifying Python project configuration?

Syncing README files after configuration changes involves updating sections that document entrypoints, setup, environment variables, and outputs to accurately reflect modified deployment manifests or code structure.

Does documentation maintenance automation work for Python projects with modified deployment manifests?

Yes, documentation maintenance automation works for Python projects by targeting touched runnable scripts and related modules, applying updates when changes occur in code, configuration, or deployment manifests to keep docs in sync.

Can I update architecture docs automatically without conducting a full repository audit?

You can update architecture docs without a full repository audit by analyzing only changed files and performing non-invasive edits to architecture notes when code structure or data flow changes are detected.

When should I not use automated documentation updates for my codebase?

You should avoid automated documentation updates when a full repository audit is required, as this process specifically targets touched modules and limits non-invasive edits to changed files rather than scanning the entire codebase.