weed-docs

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.