skills.rest
WolframResearch
WolframResearchOFFICIAL
Explore all skills by this author →
WebsiteGitHub

update-docs

Automates review of branch changes and updates Markdown documentation accordingly.

82|19|Updated Mar 21, 2025
Search Tags:#documentation#markdown#update#git-diff#content-sync#branch-changes
One-click install
npx skills add https://github.com/WolframResearch/AgentTools --skill update-docs-wolframresearch
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/WolframResearch/AgentTools/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/WolframResearch/AgentTools --skill update-docs-wolframresearch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams automatically review changes on a development branch and propagate updates to Markdown documentation, ensuring docs stay aligned with code.

Core Features & Use Cases

  • Analyze differences between base and HEAD to identify modified documentation files.
  • Read changed source files to infer necessary updates and generate aligned documentation content.
  • Apply non-destructive edits to existing Markdown files and propagate changes across related docs (README, AGENTS.md, and docs folder).
  • Use Case: When implementing a new feature or refactor, quickly synchronize documentation to reflect new APIs, usage notes, and examples.

Quick Start

Review branch changes and update markdown documentation files to reflect them.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep markdown documentation in sync with code changes on a branch?▼

This Skill reads git diffs between your base branch and HEAD to identify modified source files, then infers and applies necessary updates to Markdown documentation while preserving original content and format.

Can I update README and AGENTS.md files without destroying original content?▼

Yes, you can update README and AGENTS.md files using non-destructive edits that preserve original content and format. The process parses existing Markdown and propagates aligned content across related docs.

Does this approach work with existing git diff workflows for content sync?▼

Yes, content sync works with existing git diff workflows by analyzing differences between base and HEAD. It reads changed source files to generate aligned documentation content automatically for modified files.

What is the best way to automatically generate docs for new APIs?▼

The best way to automatically generate docs for new APIs is to analyze branch changes and propagate updates to Markdown documentation. This aligns usage notes and examples across README and docs folder files.

Are there limitations when applying non-destructive edits to markdown files?▼

A key limitation is that non-destructive edits focus strictly on Markdown documentation files across modified files. It preserves original content and format but does not alter source code or non-Markdown assets.

Related Skills

Explore More Content & Communication Skills→
ather-techieather-techie
6

check-feature-docs

Audits git repository changes to ensure documentation files are updated.

Community
Intermediate
ksleungacksleungac
17

readme

Synchronize English README content with Traditional and Simplified Chinese translations.

Community
Intermediate
rysweetrysweet
2

mermaid-diagram-generator

Convert architecture and workflow descriptions into valid Mermaid diagrams.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced