skills.rest
albertoirurueta
albertoiruruetaCOMMUNITY
Explore all skills by this author →
GitHub

update-docs

Updates Antora AsciiDoc documentation to reflect codebase changes using Git refs or ranges.

Updated Jul 9, 2026
Search Tags:#git#documentation#asciidoc#codebase synchronization#antora
One-click install
npx skills add https://github.com/albertoirurueta/ai-catalog --skill update-docs-albertoirurueta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/albertoirurueta/ai-catalog/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/albertoirurueta/ai-catalog --skill update-docs-albertoirurueta

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your Antora-based documentation is up-to-date with the latest changes in your codebase, eliminating outdated information and maintaining accurate documentation.

Core Features & Use Cases

  • Automated Documentation Update: Reflects changes in the codebase, such as new/changed APIs, types, behavior, or conventions.
  • Selective Updates: Allows for specifying a specific commit, ref, or range to update only the relevant documentation.
  • Mermaid and MathJax Support: Incorporates diagrams and equations for clarity where appropriate.
  • No Source Code Changes: Does not alter source code or introduce new documented behavior not present in the code.

Quick Start

Run the /update-docs command to update documentation with all uncommitted changes and commits on the current branch not yet on the base branch. For specific refs/ranges, use /update-docs <git-ref-or-range>.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep Antora documentation in sync with codebase changes?▼

Antora documentation synchronization updates AsciiDoc files to reflect codebase changes like new APIs or conventions, using Git history to track what needs updating without altering source code.

Can I update AsciiDoc files for a specific Git commit or range?▼

Yes, AsciiDoc selective updates support specifying a specific commit, ref, or range, allowing you to target only the documentation relevant to those particular codebase changes.

Does Antora documentation synchronization support Mermaid diagrams and MathJax equations?▼

Antora documentation synchronization supports incorporating Mermaid diagrams and MathJax equations into AsciiDoc files to visually clarify updated codebase behavior and mathematical logic.

How do I automate documentation updates for uncommitted Git changes?▼

Automate documentation updates by running the update command to process all uncommitted changes and branch commits not yet on the base branch, reflecting them in Antora AsciiDoc.

Will updating Antora docs modify my source code?▼

Updating Antora docs does not modify source code, strictly ensuring that the synchronization process only alters AsciiDoc documentation to match existing codebase behavior without introducing new code.

What is the best way to maintain AsciiDoc documentation across multiple Git branches?▼

Maintaining AsciiDoc across branches uses Git version control to selectively update Antora documentation by comparing branch commits against a base branch, ensuring docs accurately reflect branch-specific codebase changes.

Related Skills

Explore More Software Engineering Skills→
catlog22catlog22
511

manage-codebase-refresh

Refresh documentation entries for files changed in Git.

Community
Intermediate
musingfoxmusingfox
2

doc-render

Render Markdown documents as formatted HTML pages with syntax highlighting, diagrams, and math.

Community
Advanced
ngareleongareleo
1

update-docs

Edit Mermaid diagrams and regenerate PNGs to synchronize streaming architecture documentation.

Community
Basic
erichowenserichowens
181

skill-documentarian

Synchronize Claude skill documentation with website metadata and regenerate artifacts.

Community
Advanced