docs: audit fixes — nav orphans, stale refs, version sync, hygiene tests#509
Merged
bradygaster merged 3 commits intobradygaster:devfrom Mar 23, 2026
Merged
Conversation
diberry
pushed a commit
to diberry/squad
that referenced
this pull request
Mar 22, 2026
…nav sanity checks scripts/sync-whatsnew-version.mjs: - Wrap readFileSync/writeFileSync in try/catch with actionable error messages - Validate pkg.version is a non-empty string before use; exit 1 if missing/invalid - Tighten CURRENT_RELEASE_RE regex from [\d.][\d.]* to \d+\.\d+\.\d+ (proper semver) test/whatsnew-version-sync.test.ts: - Match script: tighten regex capture group to \d+\.\d+\.\d+ (semver) test/docs-build.test.ts: - getNavSlugs() now throws if it returns 0 slugs (guards against silent format change in navigation.ts) - Add 'allowlists contain only files that exist on disk' test — stale allowlist entries now fail CI All 30 tests pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
Author
|
Hey @bradygaster — this is ready for your review. squad obo dina Summary: Full docs catalog audit and remediation. PAO audited 90+ pages, found 5 classes of issues, team fixed them all and added regression tests. Reviewed by: Flight (approve), CONTROL (request changes → fixed by EECOM → approve on re-review) 30/30 tests green. 4 commits, no .squad/ files in the diff. |
- Fix whatsnew.md stale version (v0.8.2 → v0.8.25) + auto-sync script - Rewrite insider-program.md install commands to current npm path - Add 9 orphaned pages to navigation.ts (FAQ, built-in-roles, etc.) - Delete 5 stale legacy root-level files via git rm - Replace deprecated .ai-team/ and npx github: refs in 10 scenario files - Add 5 docs hygiene regression tests (orphan guard, dead links, stale roots, deprecated commands/dirs) - Add LEGACY_DIR_ALLOWLIST and LEGACY_INSTALL_ALLOWLIST for migration/blog historical content - Add docs-catalog-audit skill for repeatable audits squad obo dina Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Clarify that versions before v0.8.0 were GitHub-only and npm distribution began at v0.8.0. Added a callout block after the Quick Reference table and a version boundary sentence in Scenario 5. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…nav sanity checks scripts/sync-whatsnew-version.mjs: - Wrap readFileSync/writeFileSync in try/catch with actionable error messages - Validate pkg.version is a non-empty string before use; exit 1 if missing/invalid - Tighten CURRENT_RELEASE_RE regex from [\d.][\d.]* to \d+\.\d+\.\d+ (proper semver) test/whatsnew-version-sync.test.ts: - Match script: tighten regex capture group to \d+\.\d+\.\d+ (semver) test/docs-build.test.ts: - getNavSlugs() now throws if it returns 0 slugs (guards against silent format change in navigation.ts) - Add 'allowlists contain only files that exist on disk' test — stale allowlist entries now fail CI All 30 tests pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/docs-audit-fixes
branch
from
18fe06d to
5f2cf71
Compare
chrislomonico
pushed a commit
to clomonico/squad
that referenced
this pull request
Mar 26, 2026
…radygaster#540) Wires 5 ghost commands: hire→init, heartbeat→doctor, shell→REPL, loop→triage, run→stub with redirect. Closes bradygaster#501, Closes bradygaster#503, Closes bradygaster#504, Closes bradygaster#507, Closes bradygaster#509 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
Summary
Full docs catalog audit and remediation — PAO audited 90+ pages, found 5 classes of issues, team fixed them all and added regression tests.
Changes
Fixes:
npx github:to current npm install pathavigation.ts (FAQ, built-in-roles, vscode-troubleshooting, context-hygiene, cost-tracking, issue-templates, build-autonomous-agent, choose-your-interface, github-auth-setup)
.ai-team/andnpx github:refs replaced in 10 scenario filesAutomation:
scripts/sync-whatsnew-version.mjs— auto-syncs whatsnew.md version heading on every buildpackage.jsonprebuild hookTests (6 new):
test/whatsnew-version-sync.test.ts— version heading matches package.jsontest/docs-build.test.ts: orphan detection, dead nav links, stale root files, deprecated install commands, deprecated directory refsSkill:
.squad/skills/docs-catalog-audit/SKILL.md— reusable 7-step audit methodologyTest results
squad obo dina