skills.rest
PyModel
PyModelOFFICIAL
Explore all skills by this author →
WebsiteGitHub

gen-docs

Update VitePress user documentation after code changes affecting product behavior.

18|8|Updated Jun 17, 2026
Search Tags:#git#changelog#documentation#cli#release notes#vitepress#docs sync
One-click install
npx skills add https://github.com/PyModel/pythinker-code --skill gen-docs-pymodel
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gen-docs
Source: https://github.com/PyModel/pythinker-code/tree/main/.agents/skills/gen-docs
Command: npx skills add https://github.com/PyModel/pythinker-code --skill gen-docs-pymodel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping user documentation in sync with code changes is tedious and error-prone. This Skill inspects recent commits, diffs, and changesets to identify user-facing changes, then updates the corresponding VitePress documentation pages so docs never drift from actual product behavior. ## Core Features & Use Cases - Change Inspection: Analyzes git commits, diffs, and changeset files to detect changes with user-facing impact, skipping internal refactors, tests, and CI changes. - Changelog Sync: Delegates to the sync-changelog skill to curate CHANGELOG.md entries into docs/release-notes/changelog.md without manual edits. - Style-Consistent Doc Updates: Follows the docs/AGENTS.md style guide for terminology, typography, and writing style across guides, customization, configuration, reference, and release notes sections. - Use Case: After merging a feature branch that adds a new CLI subcommand, run this Skill to update the CLI reference page, sync the changelog, and weave the new capability into existing guide prose. ## Quick Start Update the user documentation to reflect the changes on my current branch compared to main.

Frequently Asked Questions about gen-docs

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

FAQPage Schema
How do I keep user documentation in sync with code changes?▼

Inspect commits and diffs on your branch with git log and git diff, identify user-facing changes, then edit the affected documentation pages. This Skill automates that workflow for a VitePress docs site, including changelog synchronization.

How to update VitePress docs after a feature release?▼

Review the changeset files and CHANGELOG entries for the release, then update the relevant guide, configuration, and reference pages following your style guide. The Skill handles this by scanning branch changes and editing only affected sections.

Does this Skill work without a docs/AGENTS.md style guide?▼

No. The Skill requires docs/AGENTS.md as a prerequisite because it defines the source-of-truth rules, terminology table, and writing style. If it is missing, the Skill stops and reports the issue before continuing.

Can I edit docs/release-notes/changelog.md manually?▼

No. The changelog page is auto-generated by the sync-changelog skill from CHANGELOG.md, and any manual edit will be overwritten. Make corrections in the source changelog or changeset instead.

When should I use audit-docs instead of gen-docs?▼

Use gen-docs for incremental updates tied to recent code changes on a branch. Use the audit-docs skill for a full pre-release audit of all pages to detect hallucinations and coverage gaps across the entire documentation site.

Related Skills

Explore More Software Engineering Skills→
kubb-labskubb-labs
22

changelog

Generate user-facing changelogs from git commit history.

Official
Intermediate
OysteinAmundsenOysteinAmundsen
48

release-prep

Run linting, tests, builds, and release checks for Toolbox libraries.

Community
Advanced
langgeniuslanggenius
175

dify-cli-docs

Draft and edit difyctl CLI documentation verified against langgenius/dify source.

Official
Advanced
Andreicr1Andreicr1

api-documentation

Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.

Community
Advanced