update-docs

Update OTGW-firmware documentation from git diffs via a sequential backlog workflow.

199|41|Updated Oct 25, 2020
One-click install
npx skills add https://github.com/rvdbreemen/OTGW-firmware --skill update-docs-rvdbreemen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/rvdbreemen/OTGW-firmware/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/rvdbreemen/OTGW-firmware --skill update-docs-rvdbreemen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps OTGW-firmware documentation accurate and consistent by updating the right doc sections in a sequential, backlog-tracked workflow to avoid mid-run failures.

Core Features & Use Cases

  • Sequential, backlog-tracked updates: runs exactly one doc-area subagent at a time for reliability and clear progress visibility.
  • Change-driven scoping: detects what changed since the previous tag and targets only the affected documentation areas.
  • Release-aware generation: in release mode, produces release notes documents and updates breaking-changes, README, and changelog.

Quick Start

Use the update-docs skill to update only the documentation impacted by git changes since the latest release by running: /update-docs

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I automate documentation updates based on code changes in GitHub?

Automating documentation updates based on code changes is achieved by detecting git diffs and sequentially applying read-before-write updates to affected API docs and guides. This workflow tracks progress using a backlog to ensure reliability and avoid mid-run failures.

What is the best way to generate release notes for a new firmware version?

Generating release notes for a new firmware version is handled using a release-aware mode that regenerates release artifacts. This mode updates breaking changes, README files, and changelogs based on detected differences since the previous release tag.

How does a sequential backlog-tracked workflow keep documentation consistent?

A sequential backlog-tracked workflow keeps documentation consistent by running exactly one doc-area subagent at a time. This ordered execution ensures clear progress visibility and prevents mid-run failures when updating API docs or feature notes.

Can I update API docs and guides without regenerating the full release artifacts?

Updating API docs and guides without regenerating full release artifacts is supported through standalone doc updates. This mode scopes updates strictly to git diffs, targeting only the affected documentation areas rather than running the complete release process.

Do I need to manually scope documentation areas when fixing firmware docs?

Manually scoping documentation areas when fixing firmware docs is not required. The workflow is change-driven, automatically detecting what changed since the previous tag and targeting only the impacted guides, API docs, and feature notes.

Why does the documentation update workflow use ordered execution for doc areas?

Ordered execution for doc areas is used to guarantee reliable documentation updates. By processing one subagent at a time with read-before-write operations, the workflow maintains consistency across API docs, release notes, and changelogs without interruption.