skills.rest
gmanch94
gmanch94COMMUNITY
Explore all skills by this author →
GitHub

docs-stale-check

Validate Agora documentation against source-of-truth code and configs.

Updated May 2, 2026
Search Tags:#documentation#environment variables#audit readiness#API endpoints#code drift#ADR references
One-click install
npx skills add https://github.com/gmanch94/agora --skill docs-stale-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-stale-check
Source: https://github.com/gmanch94/agora/tree/main/.claude/skills/docs-stale-check
Command: npx skills add https://github.com/gmanch94/agora --skill docs-stale-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents teams from publishing outdated documentation that no longer matches the current Agora codebase, reducing confusion during onboarding and audits.

Core Features & Use Cases

  • Doc drift punch lists: Generates a line-level set of drift candidates in the specified documentation surfaces instead of rewriting content automatically.
  • Source-of-truth verification: Cross-checks lifecycle states/steps, compensator targets, API endpoints, ADR references, Make targets, module paths, environment variables, and schema fields against the authoritative code locations.
  • Release and PR hygiene: Helps keep PRDs, runbooks, and architecture diagrams aligned after changes to saga, API, agents, models, config, alembic migrations, and CI/workflow expectations.
  • Freshness and status accuracy: Flags missing or stale "Last reviewed against code" headers and incorrect test-count or shipped-vs-planned status narratives.

Quick Start

Use the docs-stale-check skill to scan README and PRD/runbook/architecture documents and produce a punch list of file:line drift candidates.

Frequently Asked Questions about docs-stale-check

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

FAQPage Schema
Can I check API endpoints and environment variables against source code automatically?▼

You can verify API endpoints and environment variables against source code by inventorying key documentation surfaces and validating them against authoritative code locations and CI workflow artifacts.

Does this documentation audit tool rewrite outdated markdown files?▼

Stale documentation occurs after changes to schemas or alembic migrations when PRDs and runbooks are not updated, which a drift audit catches by flagging incorrect test-count or shipped-vs-planned status narratives.

When should I run a documentation drift check on my project?▼

No, this documentation audit does not rewrite outdated files; it generates grouped punch-list findings with file and line locations alongside category-labelled discrepancies for manual review.

How does a stale documentation check identify missing ADR references?▼

Run a documentation drift check when preparing releases, after sizeable changes to saga, API, agents, models, config, Makefile, or alembic migrations, or when verifying if docs remain accurate.

How does a stale documentation check identify missing ADR references?▼

A stale documentation check identifies missing ADR references by cross-checking lifecycle states, compensator targets, Make targets, and module paths against the authoritative source-of-truth code locations.

Related Skills

Explore More Education & Research Skills→
erikhazzarderikhazzard
1

doc__guard-drift

Compare repository documentation against source artifacts to generate drift reports.

Community
Advanced
launchdarklylaunchdarkly
25

launchdarkly-flag-discovery

Audit LaunchDarkly feature flags and assess removal readiness across environments.

Official
Advanced
pohlai88pohlai88

database-testing

Validate database schemas, data integrity, migrations, and ACID properties.

Community
Advanced
LucasMalessaLucasMalessa

ring:using-tw-team

Dispatch specialized writers to create and review technical documentation.

Community
Advanced