doc-consistency

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

33|12|Updated Sep 24, 2024
One-click install
npx skills add https://github.com/bgaldino/rlm-base-dev --skill doc-consistency-bgaldino
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-consistency
Source: https://github.com/bgaldino/rlm-base-dev/tree/main/.cursor/skills/doc-consistency
Command: npx skills add https://github.com/bgaldino/rlm-base-dev --skill doc-consistency-bgaldino

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code and configuration changes routinely leave documentation stale: renamed tasks, outdated record counts, unregenerated references, and broken step citations slip through review. 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 plans, feature flags, Robot suites, API version bumps) with the exact docs and generated references to verify. - Verification Commands: Ready-to-run checks including generate_cci_reference.py, check_plan_readme_consistency.py --strict, validate_sfdmu_v5_datasets.py, and doc-build-step and ERD-count test gates. - Provenance Guardrails: Rules for API version sweeps that protect frozen release snapshots and VERIFIED LIVE captures from being silently retargeted. - Use Case: After renaming a CumulusCI task and editing an SFDMU export.json, run this Skill's checklist to regenerate references, grep for stale task names, and validate plan READMEs in the same commit. ## 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 from your diff. Then follow the change-surface map: regenerate CCI references, validate SFDMU plans, and grep for stale task or flow names in README.md, AGENTS.md, and docs/.

How do I update docs after changing a CumulusCI task or flow?

Run python scripts/ai/generate_cci_reference.py to regenerate tasks-reference.md, flows-reference.md, and feature-flags.md, then confirm git diff shows only intended changes. Also grep README.md, AGENTS.md, docs/, and .cursor/skills/ for any old task name.

What checks run when I change an SFDMU export.json plan?

Update the plan's README.md in the same commit, then run check_plan_readme_consistency.py --strict to compare object tables and record counts against the plan, plus validate_sfdmu_v5_datasets.py for v5 compliance. Run the checker repo-wide since one new SKU fans out across many plans.

Can an API version bump update all docs automatically?

No. bump_api_version.py handles code files, but markdown is a manual pass. Frozen corpora like docs/salesforce/ and per-release enablement extracts must never be retargeted, and VERIFIED LIVE captures need a banner caveat rather than a rewritten path.

Why does the doc build-step citation check fail after editing a flow?

Build-step numbers in docs are hand-maintained, so inserting or removing a flow step invalidates every downstream | N.M | citation. Run python tests/test_doc_build_steps.py to re-audit citations against cumulusci.yml; note it cannot run inside a git worktree.