update-doc

Align monorepo documentation with recent code changes via git diff detection.

9|2|Updated Nov 29, 2024
One-click install
npx skills add https://github.com/bbvch-ai/aihub-core --skill update-doc-bbvch-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-doc
Source: https://github.com/bbvch-ai/aihub-core/tree/main/.claude/skills/update-doc
Command: npx skills add https://github.com/bbvch-ai/aihub-core --skill update-doc-bbvch-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After code changes in the swiss-ai-hub monorepo, documentation spread across READMEs, CLAUDE.md files, skills, agents, and VitePress docs often falls out of sync, leading to broken references, outdated instructions, and wasted developer time.

Core Features & Use Cases

  • Multi-scope documentation scanning: Automatically identifies all 5 core documentation locations affected by code changes, including project READMEs, scope-level READMEs, CLAUDE.md files, Claude skill definitions, agent configs, and VitePress docs.
  • Staleness detection and correction: Catches outdated file paths, renamed APIs, removed features, and missing documentation, updating files to match current code while preserving each file's existing style and detail level.
  • Post-update validation: Runs spot-checks to ensure no stale path references remain in updated documentation.
  • Use case: After modifying an API controller in the packages/api scope, this skill automatically updates the corresponding README, CLAUDE.md, related scaffold skills, and platform VitePress docs to reflect the new endpoint structure.

Quick Start

Use the update-doc skill to sync all documentation across the swiss-ai-hub monorepo after you complete any code change that affects documented behavior.

Frequently Asked Questions about update-doc

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

FAQPage Schema
How do I sync monorepo documentation with recent code changes automatically?

To sync monorepo documentation with code changes, you need a tool that detects affected doc scopes via git diff and updates READMEs, CLAUDE.md files, and VitePress docs to match the current codebase. This preserves existing file style while correcting stale references.

What is the best way to prevent stale documentation in a monorepo after refactoring?

Preventing stale documentation in a monorepo requires scanning all core doc locations after code changes to catch outdated file paths, renamed APIs, and removed features. Post-update validation then ensures no broken path references remain in the updated files.

Can I update VitePress docs and CLAUDE.md convention files together after modifying an API?

Yes, updating VitePress docs and CLAUDE.md convention files together is possible using multi-scope documentation scanning. It automatically identifies all affected documentation assets across the monorepo and aligns them with the modified API endpoint structure.

How does documentation staleness detection work for auto-translated German docs?

Documentation staleness detection for auto-translated German docs works by applying special handling during the synchronization process, ensuring translated content aligns with recent code changes while preserving the original detail level and file style.

Does documentation synchronization preserve the existing writing style of project READMEs?

Documentation synchronization preserves the existing writing style of project READMEs by detecting affected scopes and applying updates that match the current code. It maintains each file's original detail level rather than overwriting it with a uniform format.

What are the limitations of using git diff to detect affected documentation scopes?

Using git diff to detect affected documentation scopes limits updates to tracked code changes within the monorepo. It requires code to serve as the single source of truth and may not catch undocumented behaviors or changes outside the detected diff paths.