Audit

/audit

Audit the knowledge base for quality issues: missing frontmatter, broken links, tag inconsistencies, orphaned files, and coverage gaps. Works on any markdown-heavy project.

Steps

• Parse focus area from $ARGUMENTS (optional). If provided, focus on that area (e.g., "tags", "frontmatter", "links"). If empty, run full audit.
• Find all markdown files: Use Glob to find all .md files, excluding common non-content directories: .venv/, node_modules/, .git/, archive/, .archive_old/.
• Frontmatter audit: First, scan a sample of existing files (first 10-20) to detect the frontmatter schema in use (which fields exist, what values are common for type and status). Then for each markdown file, check:
• Has YAML frontmatter (starts with --- and has closing ---)
• Core fields present: title, tags (and any other fields consistently used across the KB)
• type and status values (if used) are consistent with the detected schema
• tags is a non-empty list
• Track files missing frontmatter and files with incomplete/invalid frontmatter.
• Link check: Look for broken internal links:
• Grep for markdown links \[.*\]\(.*\.md\) and verify each target file exists
• If a link-checking script exists in the project (e.g., scripts/check_links.py), run it as well
• Tag consistency audit: Use Grep to find all tags: sections across .md files. Look for:
• Near-duplicate tags (e.g., "ai" vs "AI" vs "artificial-intelligence")
• Tags used only once (potential typos)
• Very common tags that might be too broad
• List all unique tags with counts.
• Orphaned files: Check which files are NOT referenced in any other file's related: field. Files that exist but are never cross-referenced may be orphaned.
• Content quality: Find documents that appear to be ideas or opportunities (based on detected type field or directory location) and check:
• Documents still in draft status for more than 30 days
• Documents missing key metadata fields that other similar documents have
• Documents with very little content (< 100 words, excluding frontmatter)
• Coverage gaps: Check each directory for content:
• Flag any empty or near-empty directories
• Look for directories with only 1-2 files (may need more content)
• Output report:
• ## KB Audit Report
• **Date:** [today]
• ### Summary
• Total .md files: X
• With frontmatter: X (X%)
• Without frontmatter: X
• ### Frontmatter Issues
• | File | Issue |
• |------|-------|
• | path | Missing field: type |
• ### Broken Links
• [list of broken references]
• ### Tag Analysis
• Total unique tags: X
• Single-use tags: [list]
• Potential duplicates: [list]
• ### Orphaned Files
• [files not referenced anywhere]
• ### Content Quality
• Stale drafts (> 30 days): [list]
• Missing metadata: [list]
• Low-content files: [list]
• ### Coverage
• [directory analysis]
• ### Recommendations
• 1. [specific action]
• 2. [specific action]
• 3. [specific action]

No markdown files found

Cause: Running in wrong directory or all files excluded. Fix: Ensure you're in the knowledge base root. Check exclude patterns in step 2.

Too many single-use tags

Cause: Inconsistent tagging across documents. Fix: Pick canonical tags from the most-used list. Run audit again after cleanup.

Frontmatter validation errors

Cause: YAML syntax issues (missing quotes, wrong indentation). Fix: Ensure --- delimiters are present. Use type: and status: values consistent with your KB's detected schema.