radius-update-doc

Patches existing contributor docs that drifted from changed code with minimal targeted edits.

1.7k|135|Updated Feb 20, 2021
One-click install
npx skills add https://github.com/radius-project/radius --skill radius-update-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: radius-update-doc
Source: https://github.com/radius-project/radius/tree/main/.github/skills/radius-update-doc
Command: npx skills add https://github.com/radius-project/radius --skill radius-update-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When a pull request changes a command, flag, path, or workflow, the contributor documentation that describes it silently goes stale. This Skill proposes the smallest targeted patch to realign an existing doc with the current code, without rewriting the document.

Core Features & Use Cases

  • Drift Detection and Mapping: Reads a PR diff or changed-path list and uses the code-to-doc path map to identify which doc documents the changed code.
  • Minimal Patch Generation: Locates the exact stale lines and edits only what drifted, preserving the doc's prescribed contributing or architecture format.
  • Verification: Confirms every updated command, flag, and path resolves against the post-change source, and validates spelling with make spellcheck.
  • Use Case: A PR renames a Make target referenced in a contributing guide. Provide the diff and the doc path, and the Skill pinpoints the stale section and proposes a scoped edit that keeps the five-section contributing format intact.

Quick Start

Update the contributing doc at docs/contributing/building.md to match the changes in this PR diff, keeping the edit as small as possible.

Frequently Asked Questions about radius-update-doc

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

FAQPage Schema
How do I update documentation after a code change in a PR?

Provide the PR diff or list of changed paths plus the affected doc path. The Skill maps changed code to its backing doc, locates the stale lines, and proposes a minimal patch that realigns the prose with the new code.

What is the difference between updating a doc and authoring a new doc?

Updating patches an existing doc that drifted from code with the smallest possible edit. Authoring a brand-new doc is a separate task handled by the radius-author-doc skill, which this Skill explicitly does not cover.

Can this Skill find which docs are missing or stale across the repo?

No. Finding missing or stale docs and assessing a code change's overall documentation impact is handled by the radius-contributing-docs-updater skill. This Skill only patches a specific doc once drift is identified.

How does the Skill know which doc corresponds to changed code?

It consults the code-to-doc path map in contributing-agent-assets.md, which maps changed code globs to their backing docs. If no map row exists, it searches docs/contributing and docs/architecture for prose referencing the changed command, flag, or path.

How is the patched documentation verified?

Verification checks that the edit is minimal and scoped to the drift, that the doc keeps its prescribed contributing or architecture section format, that every updated path and command resolves, and that cspell passes via make spellcheck.