update-doc

Audit code diffs and generate documentation updates across docs and README.

4|Updated Oct 12, 2021
One-click install
npx skills add https://github.com/nicolasdao/puffy-core --skill update-doc-nicolasdao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-doc
Source: https://github.com/nicolasdao/puffy-core/tree/main/.agents/skills/update-doc
Command: npx skills add https://github.com/nicolasdao/puffy-core --skill update-doc-nicolasdao

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts when features are added or APIs change. This Skill automates aligning project docs with the current codebase, reducing manual churn and ensuring developers and operators stay on the same page.

Core Features & Use Cases

  • Regenerates the documentation TOC to reflect current headings in README.md and docs/*.md.
  • Creates new documentation files when a new subsystem or API surface is introduced, and links them from the README.
  • Validates cross-links and maintains hub-and-domain gotchas structure when applicable.

Quick Start

Provide a changelog or diff summary to guide what to document, then run the update-doc skill to regenerate docs accordingly.

Frequently Asked Questions about update-doc

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

FAQPage Schema
How do I keep project documentation in sync with code changes automatically?

To keep documentation in sync with code changes, you can provide a changelog or diff summary to guide the process. The skill audits these diffs and generates precise updates across your docs/ directory and README.md to reflect the current codebase accurately.

How do I regenerate a table of contents for README and markdown docs?

Regenerating a table of contents for markdown docs is handled automatically by auditing the current headings in README.md and docs/*.md files. The skill updates the TOC structure to ensure all sections are accurately reflected and linked.

Can I automatically create new documentation files when adding a new API?

Yes, you can automatically create new documentation files when a new subsystem or API surface is introduced. The skill generates the necessary docs and establishes cross-links directly from the README to maintain structural consistency.

Does this documentation automation tool validate cross-links and gotchas alignment?

Yes, this documentation automation tool validates cross-links and maintains hub-and-domain gotchas structure. It enforces documentation standards by validating structure and checking gotchas alignment against the current codebase.

What is the best way to update README files based on a code diff?

The best way to update README files based on a code diff is to provide the diff summary directly to the automation skill. It audits the code changes and applies the necessary structural updates to the README and related artifacts.