Skip to content

docs(lab): correct the README's rule counts and client list, and chec… - #1528

Merged
Gerrrt merged 2 commits into
mainfrom
docs/lab-readme-counts
Nov 16, 2026
Merged

Gerrrt merged 2 commits into
mainfrom
docs/lab-readme-counts

Conversation

@Gerrrt

@Gerrrt Gerrrt commented Nov 16, 2026

Copy link
Copy Markdown
Owner

…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

  • No change to network segmentation or firewall rules
  • No new port published to a VLAN that could not already reach the service
  • No credential added outside secrets/*.sops.yaml

Verification

  • make validate passes
  • Deployed to the lab and confirmed working
  • Docs updated (docs/, service README, or docs/roadmap.md)

Copilot AI balanced review requested due to automatic review settings November 16, 2026 05:43
@Gerrrt
Gerrrt enabled auto-merge (squash) November 16, 2026 05:43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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

Comment thread scripts/check_docs.py Resolved
…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
Gerrrt force-pushed the docs/lab-readme-counts branch from a2a3f0a to c4e1cda Compare November 16, 2026 09:51
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>
@Gerrrt
Gerrrt merged commit 029982c into main Nov 16, 2026
8 checks passed
@Gerrrt
Gerrrt deleted the docs/lab-readme-counts branch November 16, 2026 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants