contributing-docs-updater

Updates CONTRIBUTING.md and related docs for repository workflow accuracy and consistency.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps maintain contributor-facing documentation to stay aligned with repository changes, ensuring contributions are guided by accurate docs.

Core Features & Use Cases

  • Aligns CONTRIBUTING.md, docs/contributing/, and docs/architecture/ across the repo.
  • Reviews doc changes for accuracy and completeness during code reviews.
  • Gap analysis and recommendations for missing contributor guidance.

Quick Start

Update or review contributor documentation for a code change by running a targeted doc review within the repository.

Frequently Asked Questions about contributing-docs-updater

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

FAQPage Schema
How do I keep CONTRIBUTING.md aligned with repository changes?

To keep CONTRIBUTING.md aligned, run a targeted doc review to verify commands, file paths, and references against the repo, ensuring accurate contributor guidance for setup and review workflows.

What is contributor documentation gap analysis?

Contributor documentation gap analysis identifies missing guidance across docs/contributing/ and docs/architecture/, recommending updates to ensure build, test, and deployment scenarios are fully covered.

How do I review documentation accuracy during a code review?

Review documentation accuracy during code reviews by verifying updated file paths and commands against repository changes, checking that contributor workflows in docs remain consistent and complete.

Does this docs updater work with existing architecture documentation?

Yes, this docs updater works with existing architecture documentation by scoping reviews to include docs/architecture/, verifying technical references to maintain accurate deployment and build guidance.

What's the best way to update contributor workflows after changing build setup?

The best way to update contributor workflows after changing build setup is performing a targeted doc review to verify commands and paths, ensuring deployment guidance and setup instructions remain accurate.