skills.rest
northguild
northguildOFFICIAL
Explore all skills by this author →
GitHub

update-readme

Updates README files to reflect API changes detected in branch diffs.

6|Updated Mar 10, 2026
Search Tags:#documentation#markdown#readme#monorepo#api changes#git diff#changeset
One-click install
npx skills add https://github.com/northguild/gmt --skill update-readme-northguild
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-readme
Source: https://github.com/northguild/gmt/tree/main/.agents/skills/update-readme
Command: npx skills add https://github.com/northguild/gmt --skill update-readme-northguild

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Keeping multiple README files synchronized with code changes is tedious and error-prone. This Skill automates the process of diffing a branch against main, identifying user-facing API changes, and updating the root README, package README, and namespace READMEs accordingly. ## Core Features & Use Cases - Diff-grounded updates: Runs git log and git diff against main, reads changesets, and builds a list of new, renamed, or removed exports before touching any file. - Multi-level README sync: Handles the root README, packages/gmt/README.md, namespace stub READMEs, and sub-package READMEs with level-specific rules. - Stale reference verification: Greps for renamed or removed function names across all README levels to confirm nothing outdated remains. - Use Case: After adding a new exported function or renaming an existing one in the @northguild/gmt library, run this Skill to propagate the change into every affected README without inventing function names or drifting from established formatting style. ## Quick Start Ask the assistant to update the READMEs to reflect the API changes on the current branch.

Frequently Asked Questions about update-readme

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

FAQPage Schema
How do I update README files after changing exported functions?▼

Run this Skill after adding, removing, or renaming exports. It diffs the branch against main, reads the changesets, identifies affected README levels, and updates each file while matching the existing style exactly.

How to keep monorepo READMEs in sync with code changes?▼

Use a diff-grounded workflow: run git log and git diff against main, read the changesets, then update only the README levels affected by the changes. This Skill automates that process across root, package, and namespace READMEs.

Does this Skill update namespace README function lists?▼

No. Namespace READMEs are one-line stubs pointing at the docs site, and the function reference is generated automatically by the docs build. They are only updated if the reference path slug changes, such as after a namespace rename.

When should I run the update-readme workflow?▼

Run it after adding, removing, or renaming exported functions, adding a new namespace module, or changing significant consumer-facing behavior. It is triggered by requests like "update the README" or "sync the docs".

What are the limitations of automated README updating?▼

The Skill only describes changes visible in the diff and changesets; it never invents function names or fabricates content. Every listed function must exist in the source, verified via grep or the barrel export files.

Related Skills

Explore More Software Engineering Skills→
lowdefylowdefy
3.0k

l-changeset

Generate changeset files from Git commits with bump types.

Official
Advanced
enigmaicon-engenigmaicon-eng
1

claude-code-plugin-release

Automate semantic versioning and release operations for Claude Code plugins.

Community
Advanced
netbox-communitynetbox-community
21.3k

run-tests

Run NetBox Django tests via manage.py with testing configuration.

Official
Intermediate
ShunsukeHayashiShunsukeHayashi

doc-generator

Generate JSDoc, README, API references, and CHANGELOGs from code.

Community
Intermediate