rawgentic:update-docs

Orchestrate a 10-step documentation update workflow with accuracy verification against code.

2|Updated Mar 3, 2026
One-click install
npx skills add https://github.com/3D-Stories/rawgentic --skill rawgentic-update-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rawgentic:update-docs
Source: https://github.com/3D-Stories/rawgentic/tree/main/skills/update-docs
Command: npx skills add https://github.com/3D-Stories/rawgentic --skill rawgentic-update-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures your project documentation remains accurate, comprehensive, and aligned with your codebase, preventing outdated or misleading information.

Core Features & Use Cases

  • Automated Documentation Audits: Verifies factual claims against the codebase.
  • Guided Workflow: Leads you through updating, creating, or restructuring documentation.
  • Quality Gates: Includes accuracy verification, user review, and conventional commit PRs.
  • Use Case: When you update an API endpoint, use this Skill to automatically update the corresponding API reference documentation, ensuring it reflects the latest changes and is verified against the code.

Quick Start

Use the update-docs skill to update the API reference section for the new user authentication feature.

Frequently Asked Questions about rawgentic:update-docs

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

FAQPage Schema
How do I keep my project documentation accurate and aligned with code changes?

To keep documentation accurate and aligned with code, you can use an automated workflow that audits factual claims against your codebase, drafts updates, verifies accuracy, and creates pull requests with conventional commits.

What is the best way to automate updating API reference docs after a pull request?

Automating API reference documentation updates involves a guided workflow that validates scope, drafts content, verifies factual accuracy against actual code, and submits a conventional commit pull request for user review.

How does code verification work when updating technical documentation?

Code verification for documentation updates works by enforcing an accuracy-first principle where all factual claims in the drafted docs are systematically checked against the actual codebase before user review.

Can I use conventional commits for documentation-only pull requests?

Yes, you can use conventional commits for documentation pull requests by orchestrating a workflow that drafts, verifies, and submits doc updates with properly formatted commit messages.

What are the limitations of automated documentation audits?

Automated documentation audits require scope validation and user review, meaning the workflow guides drafting and accuracy verification against code but still depends on human approval before final pull request creation.

Do I need to manually review documentation generated through an accuracy-first workflow?

Yes, you need to manually review generated documentation because the workflow includes a mandatory user review stage after code accuracy verification and before the final pull request is created.