update-docs

Detect codebase changes and synchronize documentation across docs folders and website rendering code.

Updated Jan 4, 2026
One-click install
npx skills add https://github.com/threadedstack/threadedstack --skill update-docs-threadedstack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/threadedstack/threadedstack/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/threadedstack/threadedstack --skill update-docs-threadedstack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes in a monorepo frequently leave documentation stale, with outdated API examples, missing features, and broken navigation. This Skill detects what changed, compares it against existing docs, and plans and implements updates so documentation stays accurate and in sync with the code. ## Core Features & Use Cases - Change Detection: Runs git diff commands to identify changed source files, groups them by sub-repo, and filters for changes affecting user-facing behavior. - Planned Doc Updates: Maps changed behavior to affected doc pages, then updates existing pages, creates new pages, and registers them in _meta.json navigation. - Build Verification: Runs the website build and type checks, fixes MDX or link errors iteratively, and cross-references API examples and CLI commands against actual code. - Use Case: After adding a new API endpoint and CLI command on a feature branch, run this Skill to update the API reference, CLI guide, and feature docs, then verify the docs site builds cleanly. ## Quick Start Ask the assistant to detect recent code changes and update the documentation so the docs match the current implementation.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep documentation in sync with code changes?▼

Run this Skill after making code changes. It detects changed files with git diff, maps them to affected doc pages, updates or creates documentation, and verifies the result with a website build and type checks.

How to add a new documentation page to website navigation?▼

Create the markdown file in the appropriate docs section, then add its slug to that section's _meta.json pages array. Pages not listed in _meta.json will not appear in the sidebar navigation.

Which documentation folders are rendered on the website?▼

Only docs/architecture, docs/features, docs/user-guide, and root-level files like index.md are rendered. Folders such as plans, meta, payments, and developer are excluded from the website glob patterns and are out of scope.

Why does the documentation website build fail after editing docs?▼

Common causes include MDX syntax errors, broken relative .md links, missing images, and _meta.json entries without matching markdown files. The Skill reads build output, fixes root causes, and retries up to three iterations.

Does the Skill commit documentation changes to git?▼

No. The Skill never commits or modifies git history. It implements and verifies documentation changes, then reports a summary while leaving all git operations to the user.