scrub-docs-code-parity

Detect and correct documentation drift in the Marin repository.

1.2k|146|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/marin-community/marin --skill scrub-docs-code-parity
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scrub-docs-code-parity
Source: https://github.com/marin-community/marin/tree/main/.agents/skills/scrub-docs-code-parity
Command: npx skills add https://github.com/marin-community/marin --skill scrub-docs-code-parity

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the common issue of documentation and code becoming out of sync, ensuring that the repository's documentation accurately reflects its current codebase and operational conventions.

Core Features & Use Cases

  • Automated Drift Detection: Identifies discrepancies between documentation (README, docs/) and actual code behavior, focusing on high-confidence drift.
  • Example Verification: Confirms that command examples in documentation match current tooling conventions (e.g., uv run, repo scripts).
  • Use Case: Regularly scheduled checks to maintain the integrity of the Marin repository's documentation, ensuring tutorials and examples are always up-to-date with the latest code changes.

Quick Start

Run the scrub-docs-code-parity skill to check for and fix documentation and code inconsistencies.

Frequently Asked Questions about scrub-docs-code-parity

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

FAQPage Schema
How do I detect documentation drift in my repository?

Documentation drift is detected by running scheduled maintenance checks that identify discrepancies between README files, docs directories, and the actual codebase behavior. This process focuses on high-confidence drift to ensure repository documentation accurately reflects current operational conventions.

How do I verify command examples in documentation against current tooling conventions?

Verifying command examples in documentation against current tooling involves checking that documented commands match active repository scripts and tooling conventions like uv run. This ensures tutorials and examples remain up-to-date with the latest code changes.

What is the best way to keep README and docs in sync with code changes?

The best way to keep README and docs in sync with code changes is through automated drift detection and example verification. Regularly scheduled checks identify and correct discrepancies, maintaining a high level of transparency and usability for the project's documentation.

Can I use scheduled tasks to automate repository maintenance and documentation checks?

Scheduled tasks can automate repository maintenance and documentation checks by performing routine scans for code parity. This identifies and corrects inconsistencies in agent scripts and documentation, ensuring repository integrity without manual intervention.

Why does my documentation not match the current codebase behavior?

Documentation may not match the current codebase behavior due to drift, where updates to code are not reflected in docs. Identifying and correcting this drift ensures that command examples and operational conventions remain accurate and usable.