docs

Update project documentation to reflect completed, verified work.

8|1|Updated Apr 8, 2026
One-click install
npx skills add https://github.com/yulonghe97/ystack --skill docs-yulonghe97
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/yulonghe97/ystack/tree/main/skills/docs
Command: npx skills add https://github.com/yulonghe97/ystack --skill docs-yulonghe97

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill updates documentation to reflect completed, verified work rather than planned or in-progress items.

Core Features & Use Cases

  • Map code changes to the corresponding docs using the module registry and scope globs
  • Read and apply progress gating to only document finished work
  • Update navigation, cross-references, and module mappings to reflect released features

Quick Start

Review the latest changes and update the documentation to reflect completed, verified work.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I update documentation to only reflect completed and verified work?

To update documentation for verified work, you can use an automated approach that reads your progress file and feature plans to ensure only finished features are documented. This prevents planned or in-progress items from being published prematurely.

How do I map code changes to the corresponding documentation files?

Mapping code changes to documentation relies on the module registry and scope globs. By consulting the module registry, the system determines the affected scope and automatically links your changed code to the corresponding docs that need updates.

What is the best way to keep project documentation synced with released features?

Keeping documentation synced with released features requires applying progress gating to your update process. This ensures that navigation, cross-references, and module mappings are only adjusted to reflect features that are fully finished and verified.

How does progress gating work for documentation updates?

Progress gating for documentation updates works by reading a designated progress file and feature plans to check completion status. It restricts the update process so that only code changes mapped to fully verified features trigger a documentation update.

Can I automatically update navigation and cross-references in my docs?

Yes, you can automatically update navigation and cross-references in your docs. When mapping changed code to affected documentation, the system simultaneously updates navigation links and module mappings to accurately reflect the newly released features.

Why does my documentation include features that are still in progress?

Documentation includes in-progress features when updates are not gated by project progress. To fix this, documentation updates should read the progress file and apply strict gating, ensuring that only completed, verified work is mapped and added to the docs.