One-click install
npx skills add https://github.com/Dragoon0x/dragoon-skills --skill docs-dragoon0x
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Dragoon0x/dragoon-skills/tree/main/skills/docs
Command: npx skills add https://github.com/Dragoon0x/dragoon-skills --skill docs-dragoon0x

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Documentation often drifts out of sync with the actual codebase after refactors or updates, leading to broken examples, missing scripts, and confused users that waste time following outdated instructions.

Core Features & Use Cases

  • Drift Detection: Scans all markdown files in your project to identify 4 types of documentation drift: missing npm scripts, uninstalled scoped dependencies, non-existent file paths, and undocumented npm scripts.
  • Pre-Release Audits: Use it before shipping code to catch broken references that would frustrate users or contributors.
  • Post-Refactor Checks: Run it after major codebase changes to ensure all documented examples and paths still match the actual code.

Quick Start

Ask the AI to run the docs skill on your project root to scan all markdown files for drift and get a list of broken references and missing scripts with suggested fixes.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I detect documentation drift in markdown files after a refactor?

Run a documentation audit to scan all markdown files for missing npm scripts, uninstalled scoped dependencies, and non-existent file paths. This drift detection process catches broken references and stale examples by comparing documented code against the actual codebase.

Can I validate markdown references against my codebase before a release?

Yes, you can validate markdown references by running a pre-release documentation audit. This scans all markdown files for undocumented npm scripts and broken file paths, exiting with a non-zero status when drift is found.

What is the best way to find stale references and broken examples in project docs?

The best way to find stale references is to scan all markdown files for non-existent file paths and uninstalled scoped dependencies. This automated documentation audit provides actionable findings with file locations and line numbers.

How do I check for missing or undocumented npm scripts in my markdown documentation?

To check for undocumented npm scripts, scan your markdown documentation files against your actual codebase. This drift detection identifies npm scripts that exist in your package configuration but are missing from your markdown files.

Does the documentation audit exit with a non-zero status when broken paths are found?

Yes, the documentation audit exits with a non-zero status when drift is found. It reports broken file paths, missing npm scripts, and uninstalled scoped dependencies with suggested fixes to prevent releasing stale documentation.

Can I use this to check codebase hygiene without installing additional dependencies?

Yes, you can check codebase hygiene without additional dependencies. The skill scans markdown files to detect drift between documentation and the actual codebase, requiring no external dependencies to identify broken references.