crowi-docs-refresh

Updates Crowi site documentation against merged code changes and fixes stale claims.

1.1k|165|Updated Aug 18, 2014
One-click install
npx skills add https://github.com/crowi/crowi --skill crowi-docs-refresh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: crowi-docs-refresh
Source: https://github.com/crowi/crowi/tree/main/.claude/skills/crowi-docs-refresh
Command: npx skills add https://github.com/crowi/crowi --skill crowi-docs-refresh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation for the Crowi site (apps/crowi-site) drifts out of sync with the main branch as features and fixes are merged, leaving user-facing docs missing new behavior or describing outdated behavior. This Skill performs a periodic maintenance pass that both documents recent user-visible changes and hunts down stale descriptions by verifying claims against the actual code.

Core Features & Use Cases

  • Delta-driven doc updates: Extracts user-visible changes since the last sync (tracked via a watermark in .feature-state/docs-sync-state.json) using changesets and commit history, then writes new documentation from the actual implementation code rather than commit messages.
  • Staleness sweep with claim verification: Cross-checks existing docs claims against env schemas, config files, renderer registrations, package.json scripts, and port definitions, then applies a fix-or-drop policy to every finding.
  • Bilingual parity and build gates: Enforces simultaneous ja/en page updates, runs a parity check on changed docs, and validates with the Fumadocs site build, lint, and type-check before committing.
  • Use Case: Before a release pre-flight, run the Skill to catch up the crowi.wiki docs on three recently integrated features, fix two outdated config descriptions, and advance the sync watermark in one commit.

Quick Start

Run the crowi-docs-refresh skill to bring the site documentation up to date with the latest merged changes on main and clean up any stale descriptions.

Frequently Asked Questions about crowi-docs-refresh

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

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

This Skill tracks a watermark of the last documented commit, extracts user-visible changes since then from changesets and commit logs, and writes docs from the actual implementation code. It commits the updates and advances the watermark atomically.

How do I find outdated or stale documentation in a docs site?

The Skill runs a claim-verification sweep that cross-checks documentation statements against env schemas, config files, renderer registrations, package.json scripts, and port definitions. Each finding is either fixed or explicitly dropped with a one-line justification.

Does it support bilingual Japanese and English documentation?

Yes, it writes ja and en pages simultaneously and never commits a single-language update. A parity gate compares changed docs paths across both locales to detect one-sided updates before committing.

What happens when there are no documentation-worthy changes?

If the git range contains no user-visible changes, the Skill runs only the staleness sweep against existing pages and advances the sync watermark. It still reports any stale claims found and fixed during that pass.

When should I not use this Skill for documentation work?

Do not use it for features not yet merged to main, for large features needing entirely new documentation chapters, or for spec and RFC documents. Those cases are deferred to design or planning workflows instead.