Skip to content

docs: fix drift against current code, drop the flaky macOS integration CI leg - #6

Merged
takeokunn merged 1 commit into
mainfrom
docs/audit-drift
Aug 20, 2026
Merged

docs: fix drift against current code, drop the flaky macOS integration CI leg#6
takeokunn merged 1 commit into
mainfrom
docs/audit-drift

Conversation

@takeokunn

Copy link
Copy Markdown
Collaborator

Summary

  • Comprehensive docs-vs-code drift audit (README, docs/src/, docs/notes/, man page): missing builtins, broken cross-references, a stale test name, and undocumented CLI flags.
  • Corrects docs/notes/value-struct-audit.md's struct table against a full defstruct sweep of src/ (137 → 138 entries).
  • Points the vulnerability-reporting link at this repo's own SECURITY.md rather than the org-wide one, matching GitHub's own Security-tab precedence.
  • Drops the aarch64-darwin (macos-14) leg from the integration CI matrix — its runs were unreliable enough under CI load to be worse than no coverage — and updates the docs pages that described it as part of that matrix.

Test plan

  • git diff --stat reviewed; docs/CI-only change, no source (.lisp) files touched
  • docs/notes/value-struct-audit.md row count (grep -c '^| \'`) matches the corrected total (138)
  • CI green (expect: build release binary's pre-existing patchelf baseline failure only; integration tests now single-target x86_64-linux)

…n CI leg

- Add 6 missing builtins to the reference doc and man page (break, command,
  continue, eval, kill, wait), plus pipeline-graph and printf to the man page.
- Fix three broken cross-references to docs/notes/*.md and one stale test
  name in timeout-audit.md.
- Document the previously-undocumented -i/--interactive, --no-config,
  --config PATH, and --no-history CLI flags in getting-started.md and the man
  page's SYNOPSIS/OPTIONS.
- Correct value-struct-audit.md's struct table: two removed/renamed structs,
  one row with a stale file path and missing slots, and three structs that
  were never listed. Updates the total from 137 to 138.
- Point README and contributing.md's vulnerability-reporting link at this
  repo's own SECURITY.md instead of the org-wide one, matching what GitHub's
  Security tab actually surfaces.
- Remove the aarch64-darwin (macos-14) leg from the integration CI matrix:
  its runs were unreliable enough under CI load to be worse than no coverage.
  Updates the three docs pages that described it as part of the CI matrix.
@takeokunn
takeokunn merged commit fdbab0b into main Aug 20, 2026
2 of 3 checks passed
@takeokunn
takeokunn deleted the docs/audit-drift branch August 20, 2026 00:15
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