skills.rest
kslhunter
kslhunterCOMMUNITY
Explore all skills by this author →
GitHub

sd-readme

Automates README updates for packages in the `packages/` directory based on git commit history and diffs.

2|2|Updated Jul 10, 2024
Search Tags:#automation#git#documentation#readme#workflows#code-review#package-management
One-click install
npx skills add https://github.com/kslhunter/simplysm --skill sd-readme
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sd-readme
Source: https://github.com/kslhunter/simplysm/tree/main/.claude/skills/sd-readme
Command: npx skills add https://github.com/kslhunter/simplysm --skill sd-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps package README files up to date by reflecting the latest code changes based on commit history.

Core Features & Use Cases

  • Automated README synchronization: analyzes the package's commit history to identify changes that affect the README and updates it accordingly.
  • API & usage documentation guidance: helps document new exports, API changes, and usage examples with consistent formatting.
  • Workflow for updates: provides a repeatable process to review commits and refresh documentation while preserving existing structure.

Quick Start

Provide the package path or name to refresh its README using commit history since the last update.

Frequently Asked Questions about sd-readme

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

FAQPage Schema
How do I automatically update a package README to reflect recent code changes?▼

You can automate README synchronization by applying this Skill to any package path; it analyzes git commit history and diffs to categorize code changes and propose targeted documentation updates.

What is the best way to document new API exports and usage examples from git history?▼

Documenting new API exports from git history is handled by analyzing commit diffs to detect code changes, categorizing them, and generating consistent formatting guidelines for usage examples directly in the README.

Do I need git access to automate README updates for my packages?▼

Yes, git access is required to automate README updates, because the workflow verifies the target README exists and relies on analyzing the package's commit history and diffs to determine necessary documentation changes.

Can I use this workflow to sync documentation for any package under a packages directory?▼

You can sync documentation for any package under a packages/ directory by providing the package path, which triggers the workflow to review commits since the last update and refresh the README while preserving its existing structure.

What are the limitations of using commit history for package documentation synchronization?▼

A limitation of using commit history for documentation synchronization is that it requires an existing target README to verify, and updates are proposed based solely on analyzed code diffs rather than generating entirely new documentation from scratch.

Related Skills

Explore More Software Engineering Skills→
mgoodman60mgoodman60

commit

Generate descriptive Git commit messages from repository changes with conventional formatting.

Community
Basic
kjfsmkjfsm
1

release

Enforce pre-release checks before publishing npm packages via changesets.

Community
Intermediate
kcenonkcenon
2

documentation

Enforce documentation standards for READMEs, API docs, and code comments.

Community
Basic
olimpus-softolimpus-soft

review-py

Review Python code diffs using templates, checklists, and severity criteria.

Official
Advanced