index

Audit repository documentation against the current codebase to identify inconsistencies.

2|1|Updated Apr 14, 2026
One-click install
npx skills add https://github.com/Lincyaw/workbuddy --skill index-lincyaw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index
Source: https://github.com/Lincyaw/workbuddy/tree/main/.codex/skills/index
Command: npx skills add https://github.com/Lincyaw/workbuddy --skill index-lincyaw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, json, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill detects discrepancies between the repository documentation and its actual implementation, helping maintain accurate and reliable project information.

Core Features & Use Cases

  • Documentation Auditing: Compares markdown files and index configurations against the current codebase to identify mismatches.
  • Repo Structure Validation: Checks for stale or missing references and outdated documentation after updates.
  • Use Case: Use this Skill to verify that project docs stay current when refactoring or adding features, ensuring team alignment and reducing onboarding time.

Quick Start

Run the doc audit process on your repository to identify outdated or mismatched documentation.

Frequently Asked Questions about index

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

FAQPage Schema
How do I check if my repository documentation matches the current codebase?

To check if documentation matches the codebase, run an automated doc audit process that compares markdown files and index configurations against source code to identify mismatches and outdated references.

How do I detect drift between markdown files and yaml configurations after refactoring?

Detecting drift between markdown and yaml configurations requires parsing scripts that analyze repository structure, automatically comparing documentation content against current codebase logic to flag stale references and missing updates.

Do I need pyyaml and json dependencies to perform a repo audit for documentation consistency?

Yes, performing a repo audit for documentation consistency requires pyyaml and json dependencies to parse yaml configurations and process json data structures during the markdown analysis process.

What is the best way to maintain accurate project documentation for development teams?

Maintaining accurate project documentation is best achieved through automated auditing that identifies discrepancies between repository docs and actual implementation, ensuring continuous documentation accuracy and reducing team onboarding time.

Can I use this documentation auditing process to validate repo structure for stale references?

Yes, documentation auditing validates repo structure by checking for stale or missing references and outdated documentation after updates, applying markdown analysis scripts to detect drift during feature additions or refactoring.

Why does my project documentation show inconsistencies after adding new features?

Project documentation shows inconsistencies after adding features because documentation drift occurs naturally, requiring automated auditing scripts to compare markdown files and index configurations against the updated codebase to detect mismatches.