Repository navigation
docs(lab): correct the README's rule counts and client list, and chec… - #1528
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new rule-file count check lacks regression fixtures for matching counts, mismatches, and missing or ambiguous rule files, leaving stale-count detection unverified by CI.
1 open issue
What changed in this PR
Corrects stale information in the lab stack README and extends documentation validation to catch per-file rule-count drift that global totals miss.
Changes:
- Updates lab rule counts to 19 and 13, and lists six ingest clients and seven tokens.
- Adds a fourteenth documentation assertion checking stack README rule counts against their rule files.
- Updates the validation overview and records the correction in the changelog.
| File | Description |
|---|---|
stacks/lab/README.md |
Corrects rule counts, token names, and client verification guidance. |
scripts/check_docs.py |
Adds and registers per-file rule-count validation. |
README.md |
Documents the fourteenth assertion and its scope. |
docs/changelog.md |
Records the documentation corrections and new check. |
Review effort: Balanced
…k them The audit of alexander on 2026-11-13 found stacks/lab/README.md saying 9 and 12 rules against files holding 19 and 13, and naming three ingest clients and six tokens when there are six clients and seven. Correct both, and add a fourteenth check_docs assertion that reads each stack README's per-file rule count against its rule file, since the global totals passed throughout. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Gerrrt
force-pushed
the
docs/lab-readme-counts
branch
from
November 16, 2026 09:51
a2a3f0a to
c4e1cda
Compare
check_stack_rule_files now takes the tree it reads, and --self-test runs it against a temp stack: a matching count, one in words, a stale count, a missing rule file and an ambiguous one. self-tests.sh already discovers check_docs.py's suite, so CI runs these. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.

…k them
The audit of alexander on 2026-11-13 found stacks/lab/README.md saying 9 and 12 rules against files holding 19 and 13, and naming three ingest clients and six tokens when there are six clients and seven. Correct both, and add a fourteenth check_docs assertion that reads each stack README's per-file rule count against its rule file, since the global totals passed throughout.
What changed
Why
Blast radius
secrets/*.sops.yamlVerification
make validatepassesdocs/, service README, ordocs/roadmap.md)