update-docs-on-code-change

Automatically updates headers, docstrings, and Markdown docs after code edits.

3|Updated Jun 3, 2022
One-click install
npx skills add https://github.com/Hohlas/SoSimple --skill update-docs-on-code-change
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs-on-code-change
Source: https://github.com/Hohlas/SoSimple/tree/main/.kilocode/skills/update-docs-on-code-change
Command: npx skills add https://github.com/Hohlas/SoSimple --skill update-docs-on-code-change

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill keeps code documentation aligned with changes by updating headers, docstrings, Markdown docs, and architectural descriptions after code edits.

Core Features & Use Cases

  • Update file headers and docstrings to reflect new signatures and behavior.
  • Synchronize related Markdown documentation using established mappings.
  • Validate documentation completeness and propose splitting oversized files when needed.

Quick Start

Run a docs sync after code changes to refresh all related documentation.

Frequently Asked Questions about update-docs-on-code-change

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

FAQPage Schema
How do I automatically update documentation after code changes?

To update documentation after code changes, trigger an automated sync workflow that refreshes file headers, docstrings, and Markdown docs to match the latest code edits. It applies diffs and awaits your confirmation before applying final updates.

Can I synchronize Python docstrings and Markdown docs together?

Yes, you can synchronize Python docstrings and Markdown docs together. The workflow maps source code edits to related Markdown files, ensuring architectural descriptions and headers remain accurate across Python, IPYNB, and MQL4 sources.

What is the best way to keep code headers and architecture docs in sync?

Keeping code headers and architecture docs in sync is best handled by an automated validation workflow triggered after code edits. It updates related descriptions, validates completeness, and shows diffs before applying any changes.

Does this documentation sync workflow support IPYNB and MQL4 files?

Yes, this documentation sync workflow supports IPYNB and MQL4 files. It processes Python, MQL4, IPYNB, and Markdown sources to align headers and docstrings with recent code modifications.

How do I handle oversized Markdown documentation files?

To handle oversized Markdown documentation files, the sync workflow validates documentation completeness and proposes splitting large files into smaller ones. It enforces this update while awaiting your confirmation before changes are applied.

Why does my documentation validation fail after editing code signatures?

Documentation validation fails after editing code signatures because headers and docstrings are no longer aligned with the new behavior. Running a docs sync refreshes all related documentation and validates completeness before finalizing updates.