update-py-notes

Update Dendron notes for changed Python files with dated change summaries.

Updated Mar 10, 2024
One-click install
npx skills add https://github.com/Mjvolk3/Swanki --skill update-py-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-py-notes
Source: https://github.com/Mjvolk3/Swanki/tree/main/.claude/skills/update-py-notes
Command: npx skills add https://github.com/Mjvolk3/Swanki --skill update-py-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the process of updating documentation notes for Python code changes, ensuring that your project's documentation stays synchronized with its codebase.

Core Features & Use Cases

  • Automated Note Updates: Automatically generates or updates Dendron notes based on modified Python files.
  • Staged/Unstaged File Detection: Intelligently identifies changed files, prioritizing staged changes and falling back to unstaged modifications.
  • Use Case: After refactoring a Python module, run this skill to instantly update its corresponding Dendron note with a summary of the changes, ensuring team members are informed.

Quick Start

Update the Dendron notes for any changed Python files.

Frequently Asked Questions about update-py-notes

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

FAQPage Schema
How do I sync Python code changes to Dendron notes automatically?

You can sync Python code changes to Dendron notes by running a process that checks staged and modified files, maps the Python paths to notes, appends dated summaries, and stages the updated notes for you.

How do I update Dendron documentation for modified Python files?

To update Dendron documentation for modified Python files, trigger the note update process which auto-discovers changed files, creates any missing corresponding notes, appends a dated section with change summaries, and stages the notes.

Does this note sync tool detect unstaged Python files or only staged changes?

The note sync tool detects both staged and unstaged Python files. It intelligently prioritizes staged changes first, falling back to unstaged modifications if no staged files are found.

Can I update Dendron notes for specific Python files instead of auto-discovering all changes?

Yes, you can update Dendron notes for specific Python files. The process accepts explicit file path arguments to target individual modules directly, bypassing the auto-discovery of changed files.

What happens when a Python file is modified but its corresponding Dendron note does not exist?

When a modified Python file lacks a corresponding note, the sync process automatically creates the missing Dendron note, maps the Python file path to it, and appends a dated section summarizing the changes.