doc-consistency

Verify repository documentation matches code and configuration changes before merging a PR.

Updated Sep 23, 2026
One-click install
npx skills add https://github.com/drgaciw/rlm-base-dev-fork --skill doc-consistency-drgaciw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-consistency
Source: https://github.com/drgaciw/rlm-base-dev-fork/tree/main/.cursor/skills/doc-consistency
Command: npx skills add https://github.com/drgaciw/rlm-base-dev-fork --skill doc-consistency-drgaciw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Code and configuration changes silently stale the documentation that references them — renamed CCI tasks, changed SFDMU plans, bumped API versions, and edited flow steps all leave stale references scattered across READMEs, guides, and skill files. This Skill replaces multi-round review-loop fixes with a single pre-merge lookup pass that maps every change surface to the docs it affects. ## Core Features & Use Cases - Change-Surface Map: A lookup table pairing each change type (cumulusci.yml, tasks/*.py, SFDMU export.json, feature flags, Robot suites, API version bumps) with the exact docs and generated references to verify or regenerate. - Verification Commands: Ready-to-run gates including generate_cci_reference.py, check_plan_readme_consistency.py --strict, validate_sfdmu_v5_datasets.py, and tests for ERD counts and doc build-step citations. - Provenance Rules: Guidance for API version sweeps that protects frozen per-release corpora and VERIFIED LIVE captures from being rewritten, with a grep grammar for finding every verification marker. - Use Case: After renaming a CCI task and editing an SFDMU plan, run this Skill's checklist to regenerate the task reference, grep for the old task name across docs, and validate the plan README in the same commit. ## Quick Start Ask the agent to read .cursor/skills/doc-consistency/SKILL.md and check which documentation needs updating for the changes in your current diff before marking the PR ready.

Frequently Asked Questions about doc-consistency

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

FAQPage Schema
How do I check documentation consistency before merging a PR?▼

Run python scripts/ai/pr_gate.py --base origin/main, which selects the relevant checks from your diff. Then follow the change-surface map to verify each affected doc, regenerate CCI references, and validate SFDMU plan READMEs.

What docs must I update when renaming a CumulusCI task?▼

Regenerate the CCI reference with generate_cci_reference.py, then grep README.md, AGENTS.md, docs/, and .cursor/skills/ for the old task name and update or remove every stale reference in the same commit.

How do I keep SFDMU plan READMEs in sync with export.json?▼

Update the plan's README.md in the same commit as the plan change, then run check_plan_readme_consistency.py --strict on the plan directory. The strict flag also gates on operation, externalId, and missing-object mismatches that pass as warnings without it.

Should an API version bump update verified-live documentation captures?▼

No. Sections marked VERIFIED LIVE record what was actually exercised against a specific org and release, and the capture org's maximum API version caps what could have been called. Retarget prescriptive prose only, and state the original capture release in the banner.

Why does a grep sweep for verified markers return zero hits?▼

git grep -E does not honor \b word boundaries, so a word-boundary pattern silently matches nothing. Use the marker grammar in the Skill covering live-verified, live-tested, verified against, verified payload, and similar forms.

When should I not use this documentation consistency skill?▼

Skip it for changes with no documentation surface, such as .forceignore edits, which only need retrieve/deploy intent verified. Frozen per-release corpora under docs/salesforce/ and postman/ are never swept by hand or script.