doc-consistency

Verifies repository documentation stays aligned with code and configuration changes before merging pull requests.

5|3|Updated Sep 9, 2026
One-click install
npx skills add https://github.com/SalesforceLabs/revenue-cloud-foundations --skill doc-consistency-salesforcelabs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-consistency
Source: https://github.com/SalesforceLabs/revenue-cloud-foundations/tree/main/.cursor/skills/doc-consistency
Command: npx skills add https://github.com/SalesforceLabs/revenue-cloud-foundations --skill doc-consistency-salesforcelabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code and configuration changes silently drift out of sync with documentation: renamed tasks leave stale references in READMEs, SFDMU plan edits desync from plan READMEs, and regenerated references get forgotten. This Skill replaces multi-round review 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, SFDMU export.json, feature flags, Robot suites, API version bumps) with the exact docs and generated references to verify. - Verification Commands: Ready-to-run gates including generate_cci_reference.py, check_plan_readme_consistency.py --strict, validate_sfdmu_v5_datasets.py, and doc build-step/ERD count tests. - Provenance Protection: Rules preventing API version sweeps from rewriting verified-live captures, with a grep grammar for finding all verification markers. - Use Case: Before marking a PR ready that renames a CCI task and edits an SFDMU plan, follow the quick rules to regenerate references, grep for the old task name across docs, and run the strict plan README consistency check repo-wide. ## Quick Start Ask the agent to run the doc-consistency pre-merge review on your current branch diff and report every stale documentation reference it finds.

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/264, which selects the relevant checks based on your diff. Then follow the change-surface map: regenerate CCI references, run the strict plan README consistency check, and grep for stale task names.

What docs must I update when changing an SFDMU plan?

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

How do I handle an API version bump without breaking verified captures?

Run bump_api_version.py for code, but sweep docs manually. Retarget prose answering which endpoint to call now, but leave VERIFIED LIVE captures alone since the capture org's maximum API version caps what could have been called.

Does renaming a CumulusCI task require documentation updates?

Yes. Grep README.md, AGENTS.md, docs/, and .cursor/skills/ for the old task name and update or remove every stale reference. Also regenerate the CCI task reference with generate_cci_reference.py.

Why does the plan README consistency check pass but still have warnings?

Without the --strict flag, operation and externalId mismatches and missing-object rows are WARN-level and pass by exit code. Always run check_plan_readme_consistency.py with --strict to gate on these conditions.