skills.rest
CoderCoco-Studios
CoderCoco-StudiosOFFICIAL
Explore all skills by this author →
GitHub

write-docs

Write and verify Docusaurus documentation pages mapped from code changes.

1|Updated Apr 9, 2026
Search Tags:#documentation#technical writing#subagents#docusaurus#git diff#build verification#docs-as-code
One-click install
npx skills add https://github.com/CoderCoco-Studios/Hyveon --skill write-docs-codercoco-studios
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/CoderCoco-Studios/Hyveon/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/CoderCoco-Studios/Hyveon --skill write-docs-codercoco-studios

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a Docusaurus documentation site accurate as code changes is error-prone: pages drift from the implementation, broken links slip through, and stale guides mislead operators. This Skill maps every code change to the docs pages that must be updated, drafts them through a writer subagent, and verifies the result with three independent evaluator subagents before you call it done. ## Core Features & Use Cases - Change-to-page mapping: Runs a git diff against the base ref and routes each changed path (infra, lambdas, management app, packaging, tests, IAM policy) to the exact docs page that owns it. - Subagent-driven drafting and review: Dispatches a docs-writer subagent per page, then runs accuracy, coverage, and style evaluator subagents in parallel with the explicit base ref. - Build verification: Enforces a clean npm ci install followed by a Docusaurus build to catch broken links and MDX parse errors, since onBrokenLinks is set to throw. - Use Case: After modifying the Pulumi infra program on a feature branch, use this Skill to update docs/docs/components/infra.md and docs/docs/setup.md, audit the claims against the current code, and confirm the site builds before opening the PR. ## Quick Start Ask the assistant to update the Hyveon documentation for the changes on your current branch using the write-docs skill.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I update Docusaurus docs after changing code?▼

Run git diff against your base ref to list changed files, map each path to the docs page that owns it, then draft the updates and verify with a Docusaurus build. This Skill automates that mapping and review workflow.

How do I verify documentation accuracy against source code?▼

Dispatch an accuracy-auditor subagent with the explicit base ref, the touched pages, and the changed code files. It checks every claim on the page against the code as it exists now, and all accuracy findings must be fixed.

Why does my Docusaurus build fail with Cannot read properties of undefined?▼

That error usually comes from a stale node_modules directory out of sync with package.json, not from content. Run npm ci in the docs directory first, then rebuild to get a trustworthy signal.

Does Docusaurus fail the build on broken links?▼

Yes, when onBrokenLinks and onBrokenMarkdownLinks are set to throw, any wrong internal link fails the build. Internal links must be root-relative without a /docs prefix since routeBasePath is /.

When should I not use this documentation workflow?▼

Route OpenSpec spec prose to the opsx propose/update/sync skills, CLAUDE.md edits to the claude-md-improver skill, and ordinary code comments to normal editing. This Skill only covers the Docusaurus site under docs/docs.

Related Skills

Explore More Software Engineering Skills→
Marcel-CarrilloMarcel-Carrillo

openspec-apply-change

Implements tasks from an OpenSpec change with planning, verification, and PR creation.

Community
Advanced
cloudvoyantcloudvoyant

pr-fix

Fetch open pull requests and generate proposed code fixes for unresolved review comments.

Official
Intermediate
commontoolsinccommontoolsinc
37

knowledge-base

Resolve documentation, code, and spec conflicts using a defined source hierarchy.

Official
Basic
ngochuy13ngochuy13

doc-generator

Generate README, JSDoc/TSDoc, API docs, and changelogs from source code.

Community
Intermediate