docs: refresh stale counts + add doc-freshness test guard - #43
Merged
Conversation
Four releases of module additions (NPS, Always-On VPN, CIS Compliance, SIEM
Forwarder) left documentation counts stale. This corrects them everywhere and
adds an enforcement guard so they can't silently drift again.
Corrections (all to the live source-of-truth: 77 modules, 189 CLI actions):
* README: 181 -> 189 CLI actions (x3), the module-architecture table now
lists 70-76, a Security Operations feature bullet, directory tree + region
count to 77, and the test badge relabelled "structural tests" (distinct
from the Pester unit-test badge) at the current count.
* 34-Help.ps1: in-tool CLI-actions help 176 -> 189 + names the new actions.
* ROADMAP / CONTRIBUTING / docs/ASSURANCE_CASE: module/test counts refreshed.
* dist/ (chocolatey nuspec, scoop json, winget locale): action counts -> 189.
New guard (Tests/Run-Tests.ps1, Section 174 "Documentation Freshness"): for
README, CONTRIBUTING, ROADMAP, 34-Help, and the dist/ manifests, every quoted
"NNN CLI/available actions" must equal the live -Action count, and README's
module count must equal the live module count — derived from the codebase at
test time, so a stale doc fails the suite (and Validate-Release) before publish.
Docs + test-infra + a help string only — no behavioral change, no version bump.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Four releases of module additions (NPS, Always-On VPN, CIS Compliance, SIEM Forwarder) left documentation counts stale. This corrects them everywhere and adds an enforcement guard so they can't silently drift again.
Corrections (to the live source-of-truth: 77 modules, 189 CLI actions)
181 → 189CLI actions (×3); module-architecture table now lists rows 70–76; new Security Operations feature bullet; directory tree + region-pair count → 77; the test badge relabelled "structural tests" (distinct from the Pester unit-test badge) at the current count.176 → 189+ names the new actions.New guard —
Tests/Run-Tests.ps1Section 174 "Documentation Freshness"For README, CONTRIBUTING, ROADMAP, 34-Help, and the
dist/manifests, every quoted "NNN CLI/available actions" must equal the live-Actioncount, and README's module count must equal the live module count — both derived from the codebase at test time. A stale doc now fails the suite (andValidate-Release) before publish. This is the durable fix for the recurring count drift.Notes