One-click install
npx skills add https://github.com/juxt/claude-plugins --skill weed-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: weed-docs
Source: https://github.com/juxt/claude-plugins/tree/main/plugins/chalk/skills/weed-docs
Command: npx skills add https://github.com/juxt/claude-plugins --skill weed-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When code changes such as renamed APIs, updated CLI flags, or removed features are made, user-facing technical documentation often falls out of sync, leading to outdated information for end users and wasted time manually cross-referencing code diffs against docs content.

Core Features & Use Cases

  • Scoped Drift Audits: Defaults to auditing the current branch's diff against its base branch, or accepts custom commit ranges, file paths, or specific commits to narrow the audit scope as needed.
  • Intelligent Surface Detection: Automatically identifies changed code surfaces including renames, signature changes, new or removed public APIs, updated error messages, and modified code examples that require corresponding documentation updates.
  • Context-Enriched Flags: Cross-references related GitHub issues, PR discussions, and the chalk issue graph to add rationale to flagged items, turning bare coverage gaps into actionable, context-aware tasks.
  • Prioritized Punch List: Groups flagged docs by page, classifies items by confidence level (high, medium, coverage gap), and orders results to surface the most critical updates first. Use case: Before opening a PR that adds a new --cache-ttl CLI flag and renames the db.host config key, run this skill to get a list of all docs pages that reference the old config key or need new content for the flag, so you can update them before merging.

Quick Start

Use the weed-docs skill to audit your project's user-facing documentation for drift against your current unmerged code changes and receive a prioritized list of pages that need updates.

Frequently Asked Questions about weed-docs

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

FAQPage Schema
How do I audit technical docs for code drift after API changes?

To audit technical docs for code drift, scope the audit to your current branch diff or custom commit ranges to identify documentation needing updates due to API renames, signature changes, or removed features. You receive a page-grouped punch list of flagged items.

How do I find missing documentation for new public APIs?

Finding missing documentation for new public APIs involves detecting new public surfaces in your code changes and cross-referencing them against existing docs. This process outputs a confidence-classified punch list highlighting coverage gaps for undocumented features.

Does documentation drift detection cross-reference PR context for intent?

Yes, documentation drift detection cross-references GitHub issues, PR discussions, and issue tracker context to add rationale to flagged items. This enriches bare coverage gaps with actionable, context-aware tasks detailing why the documentation update is necessary.

Can I scope a documentation audit to specific commits or file paths?

You can scope a documentation audit by defaulting to the current branch's diff against its base, or by providing custom commit ranges, specific commits, and targeted file paths. This narrows the audit scope to surface only relevant documentation candidates for review.

What is the best way to track API change impact on user-facing docs?

The best way to track API change impact on user-facing docs is to run an intelligent surface detection audit that identifies modified public APIs and updated error messages. It produces a prioritized punch list classifying items by high, medium, or coverage gap confidence levels.

Does this documentation audit modify existing documentation files?

No, this documentation audit does not modify any documentation files. It strictly analyzes your code modifications and cross-references issue context to produce a read-only, confidence-classified punch list of pages that require manual review and updates.