Skip to content

ci: check docs against scripts - #39

Merged
locus313 merged 1 commit into
mainfrom
ci/docs-checks
Oct 9, 2026
Merged

locus313 merged 1 commit into
mainfrom
ci/docs-checks

Conversation

@locus313

@locus313 locus313 commented Oct 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

 .github/
 ├── scripts/
+│   └── check-docs.sh     # links, folder READMEs, header env vars vs README
 └── workflows/
+    └── docs.yml          # runs on .md/.sh/.bat changes (ci.yml ignores .md)
check-docs.sh
  for each tracked .md: every relative link resolves
  for each script: folder has README.md
  for each var in script header "Environment Variables": README mentions `VAR`

Follow-up to #38.

Evidence

  • Before: nothing checked docs; monitor-aspnet.bat documented 5 of its 10 env vars (DOMAIN, NOTIFY_EMAIL, SMTP_FROM, STATE_DIR, MYSQL_PORT missing) and said SMTP values could only be set in the script.
    After: the first run of the check flagged all five, monitor-domain-hosting/README.md now lists them with defaults, and check-docs.sh prints Docs checks passed. shellcheck --severity=warning is clean.

Merge Danger

Door: two-way

Blast Radius: CI

New required-looking check on PRs touching docs or scripts. A header env var missing from a folder README now fails the build. Defaults and descriptions are not compared.

Add check-docs.sh and a docs workflow that fails on broken relative
links, script folders without a README, and header env vars missing
from the folder README. Fix the monitor-domain-hosting README gaps it
found.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@locus313
locus313 merged commit a3a4c6d into main Oct 9, 2026
5 checks passed
@locus313
locus313 deleted the ci/docs-checks branch October 9, 2026 03:10
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.

1 participant