audit-docs

Audit user-facing documentation against codebase settings, paths, and tool names.

515|64|Updated Oct 23, 2024
One-click install
npx skills add https://github.com/allenhutchison/obsidian-gemini --skill audit-docs-allenhutchison
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-docs
Source: https://github.com/allenhutchison/obsidian-gemini/tree/main/.agents/skills/audit-docs
Command: npx skills add https://github.com/allenhutchison/obsidian-gemini --skill audit-docs-allenhutchison

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill keeps user-facing documentation honest by validating it against the codebase and patching drift directly in the working tree when requested. It protects readers from documentation drift when code and docs diverge.

Core Features & Use Cases

  • Drift detection and patching for docs: verify user-facing docs reflect current code.
  • Validation against code: compare settings names, defaults, command IDs, paths, and tool names.
  • Safe, reviewer-friendly patches: drift fixes written to the working tree with clear diffs and minimal intrusion.

Quick Start

Audit all user-facing docs against the codebase and patch drift in the working tree.

Frequently Asked Questions about audit-docs

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

FAQPage Schema
How do I detect documentation drift against my codebase?

Documentation drift is detected by auditing user-facing docs like README.md and AGENTS.md to validate settings names, defaults, command IDs, file paths, and tool names against current code. Patches are written directly to the working tree for review.

What is the best way to audit contributor guides for outdated code references?

Auditing contributor guides involves validating references like settings names, command palette IDs, and tool names against the codebase. This skill compares docs/guide/ and docs/reference/ files to the code and patches inconsistencies in the working tree.

Can I automatically patch README.md and AGENTS.md files when code changes?

Yes, you can patch README.md and AGENTS.md files by auditing them against the codebase. The skill identifies drift in settings, defaults, and paths, then applies minimal patches directly to the working tree for you to commit.

Does validating documentation against code require a specific framework or dependencies?

No additional dependencies are required to validate documentation against code. The skill operates independently to compare user-facing docs with the codebase and write drift patches to the working tree without external tools.

How do I verify settings names and defaults in reference docs match the actual code?

To verify settings names and defaults, audit docs/reference/ files against the codebase. The skill checks for drift in configuration values, command palette IDs, and file paths, patching discrepancies directly in the working tree.

What are the limitations of patching documentation drift in the working tree?

Patching documentation drift in the working tree does not automatically commit changes or open pull requests. The caller remains responsible for reviewing diffs, committing patched files, and opening PRs to merge the validated documentation.