Skip to content

docs: move docs site to github.github.com/squad and update repo links - #2411

Merged
tamirdresher merged 3 commits into
devfrom
squad/2405-docs-site-github-github-com
Nov 8, 2026
Merged

tamirdresher merged 3 commits into
devfrom
squad/2405-docs-site-github-github-com

Conversation

@tamirdresher

@tamirdresher tamirdresher commented Nov 8, 2026 •

Copy link
Copy Markdown
Collaborator

What

  • Moves the docs site to https://github.github.com/squad/. This covers the Astro site (base: '/squad/' is unchanged), the RSS fallback, the robots.txt sitemap (it pointed at the parked squad.dev domain), and the header, footer, home page, link-rewrite plugin, and "Edit this page" URLs.
  • Repoints docs-site and repository links to github/squad. That includes READMEs (the CLI package README is also shown on npm), CONTRIBUTING, CONTRIBUTORS, SUPPORT, current docs pages, a sample, and the pr-lifecycle skill.
  • Adds a guard so CI fails if the site location changes or links to the retired docs site or the old repository come back. The contract lives in scripts/docs-site-location.mjs. Both test/docs-site-location.test.ts (in the test job) and the docs node --test suite use it, and the docs-quality job now runs the docs suite so docs-only PRs are checked too.

Working as docs-devrel (Documentation & DevRel Engineer).

Why

GitHub Pages doesn't redirect after a repository transfer, so links to bradygaster.github.io/squad now return 404. Contributor instructions (fork URL, upstream remote, gh pr create --repo) still named the old repository.

Closes #2405

How

  • Link fixes: each link keeps its path and gets the new host. Two links that were already broken are fixed: the skills docs link, and the npx github:…#insider instruction, which now uses npm i -g @bradygaster/squad-cli@insider.
  • Kept as written:
    • blog narrative and release history, though blog link targets that returned 404 now point at the new host
    • changelogs, credits, and bradygaster/squad#NNN references
    • the npm scope, WinGet IDs, and Homebrew tap
    • the implementation-provenance schema ID (a versioned identifier)
    • spec files pinned by SHA-256
  • Guard (scripts/docs-site-location.mjs):
    • The Astro site and base, the RSS fallback, the robots.txt sitemap and the "Edit this page" URL must name the new location.

    • No link to the retired site (//bradygaster.github.io/squad, with or without a scheme, in any case) may remain. The versioned schema ID …/implementation-provenance/vN is exempt only where the version ends the URL: it must be followed by whitespace, the end of the line, one of ) " ' ` < > ], a # fragment, or a sentence-ending .. Paths below the ID, suffixes such as v1.json or v1.html, and ? queries are links.

    • Every tracked file under docs/ and samples/, plus the READMEs, contributor guides and the pr-lifecycle skill, is scanned for the old repository in web, raw, SSH, REST (repos/) and gh --repo forms. A failure lists each file:line: link.

    • Historical records keep their links through an allowlist where each entry states a reason:

      • blog posts
      • whatsnew.md from ## v1.1.0 down
      • pull request, issue, discussion and commit permalinks in the contributor credits and docs/specification/
      • the generated upgrade-matrix section of upgrading.md
      • three docs/_internal/ records

      A missing section marker exempts nothing. The tests fail if an entry is unused, has no reason, or covers a current file.

    • Docs-only PRs skip the test job, so docs-quality in squad-ci.yml also runs node --test docs/tests/astro-features.test.mjs. The suite needs only Node built-ins, so the step runs before any npm install. test/ci/docs-quality.test.ts fails if the step is removed, if the suite stops importing the guard, or if docs-quality stops running for docs-only PRs.

  • Shared files: README.md, docs/.../guide/gh-aw.md, and docs/.../features/standalone-install.md also carry gh-aw identity changes in Repo move: restore hosted gh-aw E2E and migrate the gh-aw package identity to github/squad/workflows #2403. This PR holds only their link hunks. I checked that a three-way merge of both PRs reproduces the combined result with no conflicts.
  • Open questions for maintainers:
    • The docs reference ghcr.io/bradygaster/squad-cli and squad-external-scaler, but no workflow publishes either image. Publish them under the new owner, or document building from the Dockerfile.
    • docs-quality isn't a required check on dev; only test and gh-aw strict compile are, and a skipped test job counts as passing. Until docs-quality is required, a docs-only PR can still merge while the guard fails.

Size (>20 files): 61 files: 56 mechanical link updates and 5 guard files.

  • 35 docs pages and 2 blog posts
  • 8 site config and component files
  • 7 READMEs and contributor docs
  • 2 docs notes, a skill and a sample
  • the guard: scripts/docs-site-location.mjs and its 2 tests, plus the docs-quality step in .github/workflows/squad-ci.yml and its contract test test/ci/docs-quality.test.ts

The link updates are all the same kind of change and the guard checks them, so splitting them further wouldn't make review easier.

Validation (Windows, Node 27), first review round:

Command Result
npx vitest run test/docs-site-location.test.ts test/docs-links.test.ts ✅ 2 files, 44 passed
node --test tests/astro-features.test.mjs (in docs/) ✅ 27/27
npx eslint test/docs-site-location.test.ts scripts/docs-site-location.mjs ✅ clean
Mutation proof: 17 deliberate breakages, each run and then restored ✅ Each fails the tests it should. Old links planted in current files (CONTRIBUTING.md, README.md, and the current parts of whatsnew.md, upgrading.md and contributors.md) fail both runners, and the message names file:line. Swapping the old docs-runner pattern back in fails 10 root tests. Restoring the previous root pattern fails the 2 schema-path tests. Widening or weakening an allowlist entry fails its contract tests

Second review round (5739333f, rebased on dev 0444041c):

Command Result
npx vitest run test/docs-site-location.test.ts test/ci/docs-quality.test.ts test/docs-links.test.ts test/pull-request-workflow-split.test.ts test/workflow-run-pr-binding.test.ts test/ci/changelog-gate.test.ts ✅ 6 files, 169 passed
node --test test/ci-concurrency.test.cjs test/workflows.test.cjs ✅ 48/48
node --test docs/tests/astro-features.test.mjs (repo root, the new CI step) ✅ 27/27. The step runs before any npm install, so this PR's own docs-quality job also runs it on Node 22.23.4 without node_modules
npx eslint on the guard module and its three test files ✅ clean
actionlint 1.7.12 on squad-ci.yml ✅ clean
Mutation proof: 11 deliberate breakages, each run and then restored ✅ Restoring the previous expression fails 5 tests, for example "[schema](…/v1.json)" -> [], expected ["…/v1.json"]. Breaking each delimiter rule in turn fails one named test. Removing the CI step, running another suite in it, dropping the guard import, or limiting docs-quality to push each fails one named test
Other suites that read squad-ci.yml, run before and after the change ✅ Same results both times: migrate-directory 22/22, recast-identity-neutrality 22/22, standalone-release-workflow 43/43, test/cli/init 18/18. The gh-aw suites and the two test/cli/upgrade-* suites fail the same tests both times, for local reasons: no gh-aw binary, jq differences, a Windows autocrlf assertion, and npx vs node.exe

These checks ran before the review fixes. Neither fix commit changes docs content; they change only the guard, its tests and the docs-quality step:

Command Result
markdownlint-cli2 on the docs content and README ✅ 0 errors (206 files)
cspell on the same files ✅ 0 issues (run with a shim: the repo's cspell refuses Node 27 prerelease)
Live link check of the 71 new URLs ✅ 65 return 200. The other 6 were already dead before this change or need a GitHub login
npm ci && npm run build && npm run test:build (in docs/) ✅ 188 pages built, Pagefind indexed 185, build-output tests 13/13. In dist/, the sitemap, robots.txt, RSS item links, and every og:url use https://github.github.com/squad/. The only old-host strings left are 2 blog link texts (their targets are updated) and the provenance schema ID

The PR checks don't build the Astro site; squad-docs.yml builds and deploys it on push to dev. The local build above covers that.

The other repo-move PRs are #2406, #2407, #2403, and #2404 (issues).


⚠️ Quick Check

  • If SDK/CLI source files changed: completed the applicable Changeset step below (npx changeset add / .changeset/*.md, direct CHANGELOG.md entry for maintainers, or skip-changelog label for no user-facing changes): N/A, no SDK/CLI source changes

PR Readiness Checklist

The PR readiness bot will validate these automatically after push.
Check each item before requesting review. See CONTRIBUTING.md for full details.

Branch & Commit

  • Branch created from dev (not main)
  • Branch is up to date with dev (git fetch upstream && git rebase upstream/dev)
  • Verified diff contains only intended changes (git diff --cached --stat)
  • PR is not in draft mode (mark ready when checks pass)
  • Commit history is clean (squash fixups before review)

Build & Test

  • npm run build passes: no package source changes (build verified on the combined repo-move tree)
  • npm test passes (all tests green): targeted suites above; the full suite runs in CI
  • npm run lint passes (type check clean)
  • npm run lint:eslint passes
  • For migration PRs (>20 files): include test output summary in PR description

Changeset

  • Changeset added via npx changeset add (if packages/squad-sdk/src/ or packages/squad-cli/src/ changed): N/A
  • Or direct CHANGELOG.md entry (maintainers only — write-protected for external contributors)
  • Or skip-changelog label applied (if no user-facing changes)

Docs

  • README section updated (if new feature/module)
  • Docs feature page (if new user-facing capability)

Exports

  • package.json subpath exports updated (if new module): N/A

Breaking Changes

None.

Waivers

None.

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 5739333

PR Scope: 🔧 Infrastructure

⚠️ 3 item(s) to address before review

Status Check Details
❌ Single commit 3 commits — consider squashing before review
✅ Not in draft Ready for review
✅ Branch up to date Up to date with dev
❌ Copilot review No Copilot review yet — it may still be processing
✅ Changeset present No source files changed — changeset not required
✅ Scope clean No .squad/ or docs/proposals/ files
✅ No merge conflicts No merge conflicts
✅ Copilot threads resolved 1 active Copilot thread(s) resolved (3 outdated skipped)
❌ CI passing 9 check(s) failing: samples-build, test, Policy Gates, docs-quality, sdk-exports-validation, Shebang EOL, gh-aw strict compile, Changeset Drift, changes

Files Changed (61 files, +803 −180)

File +/−
.copilot/skills/pr-lifecycle/SKILL.md +3 −3
.github/workflows/squad-ci.yml +4 −0
CONTRIBUTING.md +4 −4
CONTRIBUTORS.md +5 −5
README.md +9 −9
README.zh.md +5 −5
SUPPORT.md +1 −1
docs/astro.config.mjs +1 −1
docs/demo-agentic-sdlc-walkthrough.md +1 −1
docs/public/robots.txt +1 −1
docs/research/jsdoc-api-reference-research.md +4 −4
docs/src/components/Footer.astro +3 −3
docs/src/components/Header.astro +3 −3
docs/src/content/blog/028-new-docs-site.md +1 −1
docs/src/content/blog/033-swe-bench-lite-results.md +1 −1
docs/src/content/docs/community.md +9 −9
docs/src/content/docs/concepts/github-workflow.md +1 −1
docs/src/content/docs/concepts/your-team.md +1 −1
docs/src/content/docs/features/github-issues.md +1 −1
docs/src/content/docs/features/gitlab-issues.md +1 −1
docs/src/content/docs/features/issue-templates.md +2 −2
docs/src/content/docs/features/mcp-frontmatter.md +2 −2
docs/src/content/docs/features/plugins.md +1 −1
docs/src/content/docs/features/security-hardening.md +7 −7
docs/src/content/docs/features/skills.md +1 −1
docs/src/content/docs/features/squad-rc.md +2 −2
docs/src/content/docs/features/standalone-install.md +5 −5
docs/src/content/docs/features/tiered-memory.md +1 −1
docs/src/content/docs/get-started/installation.md +2 −2
docs/src/content/docs/get-started/migration.md +3 −3
docs/src/content/docs/guide/agent-framework-integration.md +3 −3
docs/src/content/docs/guide/build-autonomous-agent.md +2 −2
docs/src/content/docs/guide/building-extensions.md +2 −2
docs/src/content/docs/guide/building-resilient-agents.md +1 −1
docs/src/content/docs/guide/contributing.md +3 −3
docs/src/content/docs/guide/extensibility.md +3 −3
docs/src/content/docs/guide/faq.md +3 −3
docs/src/content/docs/guide/gh-aw.md +6 −6
docs/src/content/docs/insider-program.md +2 −2
docs/src/content/docs/reference/container-image.md +10 −10
docs/src/content/docs/reference/plugin-security.md +4 −4
docs/src/content/docs/reference/state-backend-selection.md +6 −6
docs/src/content/docs/reference/vscode-troubleshooting.md +5 −5
docs/src/content/docs/scenarios/aks-deployment.md +7 −7
docs/src/content/docs/scenarios/azure-container-apps.md +9 −9
docs/src/content/docs/scenarios/multi-machine-watch.md +2 −2
docs/src/content/docs/scenarios/open-source.md +1 −1
docs/src/content/docs/scenarios/production-observability.md +4 −4
docs/src/content/docs/scenarios/production-troubleshooting.md +9 −9
docs/src/content/docs/scenarios/scaling-workstreams.md +1 −1
... +11 more files

Total: +803 −180


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Active moderate and nit findings remain: the retired-site guard is inconsistent with the canonical path and schema checks, and repository-link coverage does not verify all migrated links.

2 open issues
What changed in this PR

This pull request migrates the documentation site to https://github.github.com/squad/ and updates repository, documentation, issue, discussion, and contributor links for the move to github/squad.

Changes:

  • Updates Astro configuration, RSS, sitemap, robots.txt, navigation, and edit-page URLs.
  • Repoints links across documentation, READMEs, samples, contributor files, and skills.
  • Adds automated checks for the new site location and retired links.
  • Review follow-ups remain for aligning the duplicate retired-site guard, updating remaining docs.squad.ai links in the CLI README, and broadening repository-link regression coverage.

This pull request requires changes.

File Summary
test/​docs-site-location.test.ts Adds repository-wide checks for the new docs host and retired links.
SUPPORT.md Updates the Discussions URL.
samples/​autonomous-pipeline/​index.ts Updates the sample repository attribution.
README.zh.md Updates Chinese README documentation and repository links.
README.md Updates installation, release, clone, and documentation links.
packages/​squad-sdk/​README.md Updates SDK repository and issue links.
packages/​squad-cli/​README.md Updates CLI installation, release, repository, documentation, issue, and license links.
docs/​tests/​astro-features.test.mjs Adds Astro site-location and stale-link checks.
docs/​src/​plugins/​remark-rewrite-links.mjs Updates the repository target for rewritten links.
docs/​src/​pages/​rss.xml.js Updates the RSS site fallback.
docs/​src/​pages/​index.astro Updates the homepage repository link.
docs/​src/​layouts/​DocsLayout.astro Updates “Edit this page” URLs.
docs/​src/​content/​docs/​scenarios/​scaling-workstreams.md Updates the SubSquads specification link.
docs/​src/​content/​docs/​scenarios/​production-troubleshooting.md Updates issue and support links.
docs/​src/​content/​docs/​scenarios/​production-observability.md Updates issue and support links.
docs/​src/​content/​docs/​scenarios/​open-source.md Updates the Squad repository reference.
docs/​src/​content/​docs/​scenarios/​multi-machine-watch.md Updates ADR links.
docs/​src/​content/​docs/​scenarios/​azure-container-apps.md Updates issue references.
docs/​src/​content/​docs/​scenarios/​aks-deployment.md Updates issue references.
docs/​src/​content/​docs/​reference/​vscode-troubleshooting.md Updates issue and discussion links.
docs/​src/​content/​docs/​reference/​state-backend-selection.md Updates state-backend issue links.
docs/​src/​content/​docs/​reference/​plugin-security.md Updates plugin roadmap links.
docs/​src/​content/​docs/​reference/​container-image.md Updates container-related issue links.
docs/​src/​content/​docs/​insider-program.md Updates issue and discussion links.
docs/​src/​content/​docs/​guide/​gh-aw.md Updates repository links for gh-aw documentation.
docs/​src/​content/​docs/​guide/​faq.md Updates issue and discussion links.
docs/​src/​content/​docs/​guide/​extensibility.md Updates RFC, contribution, and issue links.
docs/​src/​content/​docs/​guide/​contributing.md Updates fork, upstream, and pull request commands.
docs/​src/​content/​docs/​guide/​building-resilient-agents.md Updates the implementation PR link.
docs/​src/​content/​docs/​guide/​building-extensions.md Updates RFC and discussion links.
docs/​src/​content/​docs/​guide/​build-autonomous-agent.md Updates autonomous-pipeline sample links.
docs/​src/​content/​docs/​guide/​agent-framework-integration.md Updates source and issue links.
docs/​src/​content/​docs/​get-started/​migration.md Updates repository and changelog links.
docs/​src/​content/​docs/​get-started/​installation.md Updates installer and release links.
docs/​src/​content/​docs/​features/​tiered-memory.md Updates tiered-memory issue links.
docs/​src/​content/​docs/​features/​standalone-install.md Updates installer repository and release links.
docs/​src/​content/​docs/​features/​squad-rc.md Updates remote-control source links.
docs/​src/​content/​docs/​features/​skills.md Updates the session-recovery skill source link.
docs/​src/​content/​docs/​features/​security-hardening.md Updates security issue and source links.
docs/​src/​content/​docs/​features/​plugins.md Updates plugin roadmap links.
docs/​src/​content/​docs/​features/​mcp-frontmatter.md Updates MCP-related issue links.
docs/​src/​content/​docs/​features/​issue-templates.md Updates Discussions and documentation contact links.
docs/​src/​content/​docs/​features/​gitlab-issues.md Updates the issue tracker link.
docs/​src/​content/​docs/​features/​github-issues.md Updates the sample repository target.
docs/​src/​content/​docs/​concepts/​your-team.md Updates the charter specification link.
docs/​src/​content/​docs/​concepts/​github-workflow.md Updates the sample repository target.
docs/​src/​content/​docs/​community.md Updates badges, issue, discussion, and repository links.
docs/​src/​content/​blog/​033-swe-bench-lite-results.md Updates the blog post’s documentation URL target.
docs/​src/​content/​blog/​028-new-docs-site.md Updates the docs-site announcement URL target.
docs/​src/​components/​Header.astro Updates header and mobile GitHub links.
docs/​src/​components/​Footer.astro Updates footer community and GitHub links.
docs/​research/​jsdoc-api-reference-research.md Updates documented API-reference URLs.
docs/​public/​robots.txt Points crawlers to the new sitemap.
docs/​demo-agentic-sdlc-walkthrough.md Updates the repository reference.
docs/​astro.config.mjs Sets the new canonical site host.
CONTRIBUTORS.md Updates Insider installation and community links.
CONTRIBUTING.md Updates fork, upstream, and pull request commands.
.copilot/​skills/​pr-lifecycle/​SKILL.md Updates pull request creation commands.

Review effort: Lite (auto)

Comment thread docs/tests/astro-features.test.mjs Resolved
Comment thread test/docs-site-location.test.ts Resolved
tamirdresher pushed a commit that referenced this pull request Nov 8, 2026
Review fixes for #2411.

The node --test copy of the retired-site guard in
docs/tests/astro-features.test.mjs had drifted from
test/docs-site-location.test.ts. It flagged unrelated sites such as
bradygaster.github.io/squadcaster/, exempted every path under
/schemas/implementation-provenance/, and missed protocol-relative and
upper-case links. Both guards now import one contract,
scripts/docs-site-location.mjs: the site settings, the link patterns,
the scanned files and the historical allowlist. The retired-site pattern
ends /squad at a path boundary and exempts only the exact versioned
schema ID (.../implementation-provenance/v1), not the paths below it.

The old-repository check covered only the five site-chrome files, so a
regression in any other migrated link passed. It now scans every
tracked file under the migrated paths (docs, samples, READMEs,
contributor guides and the pr-lifecycle skill). It also catches the
raw.githubusercontent.com, SSH remote, REST and gh --repo forms that the
migration rewrote. HISTORICAL_REPO_LINKS lists what stays as written:
blog posts, release notes for v1.1.0 and earlier, contributor-credit
and spec-provenance permalinks, the generated upgrade-matrix section of
upgrading.md, and three internal launch and design records. Each entry
needs a reason and must still keep a link, and none may cover a current
entry point.

test/docs-site-location.test.ts pins the settings, the pattern examples
and the allowlist behavior. Every failure names the file and line, or
the input.

Refs #2405

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@tamirdresher
tamirdresher force-pushed the squad/2405-docs-site-github-github-com branch from 05ba0b9 to 2c403c8 Compare November 8, 2026 19:47
@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

🔴 Impact Analysis — PR #2411

Risk tier: 🔴 CRITICAL

📊 Summary

Metric Count
Files changed 61
Files added 3
Files modified 58
Files deleted 0
Modules touched 8
Critical files 1

🎯 Risk Factors

  • 61 files changed (>50 → CRITICAL)
  • 8 modules touched (5-8 → HIGH)
  • Critical files touched: samples/autonomous-pipeline/index.ts

📦 Modules Affected

ci-workflows (1 file)
  • .github/workflows/squad-ci.yml
copilot-config (1 file)
  • .copilot/skills/pr-lifecycle/SKILL.md
docs (48 files)
  • docs/astro.config.mjs
  • docs/demo-agentic-sdlc-walkthrough.md
  • docs/public/robots.txt
  • docs/research/jsdoc-api-reference-research.md
  • docs/src/components/Footer.astro
  • docs/src/components/Header.astro
  • docs/src/content/blog/028-new-docs-site.md
  • docs/src/content/blog/033-swe-bench-lite-results.md
  • docs/src/content/docs/community.md
  • docs/src/content/docs/concepts/github-workflow.md
  • docs/src/content/docs/concepts/your-team.md
  • docs/src/content/docs/features/github-issues.md
  • docs/src/content/docs/features/gitlab-issues.md
  • docs/src/content/docs/features/issue-templates.md
  • docs/src/content/docs/features/mcp-frontmatter.md
  • docs/src/content/docs/features/plugins.md
  • docs/src/content/docs/features/security-hardening.md
  • docs/src/content/docs/features/skills.md
  • docs/src/content/docs/features/squad-rc.md
  • docs/src/content/docs/features/standalone-install.md
  • docs/src/content/docs/features/tiered-memory.md
  • docs/src/content/docs/get-started/installation.md
  • docs/src/content/docs/get-started/migration.md
  • docs/src/content/docs/guide/agent-framework-integration.md
  • docs/src/content/docs/guide/build-autonomous-agent.md
  • docs/src/content/docs/guide/building-extensions.md
  • docs/src/content/docs/guide/building-resilient-agents.md
  • docs/src/content/docs/guide/contributing.md
  • docs/src/content/docs/guide/extensibility.md
  • docs/src/content/docs/guide/faq.md
  • docs/src/content/docs/guide/gh-aw.md
  • docs/src/content/docs/insider-program.md
  • docs/src/content/docs/reference/container-image.md
  • docs/src/content/docs/reference/plugin-security.md
  • docs/src/content/docs/reference/state-backend-selection.md
  • docs/src/content/docs/reference/vscode-troubleshooting.md
  • docs/src/content/docs/scenarios/aks-deployment.md
  • docs/src/content/docs/scenarios/azure-container-apps.md
  • docs/src/content/docs/scenarios/multi-machine-watch.md
  • docs/src/content/docs/scenarios/open-source.md
  • docs/src/content/docs/scenarios/production-observability.md
  • docs/src/content/docs/scenarios/production-troubleshooting.md
  • docs/src/content/docs/scenarios/scaling-workstreams.md
  • docs/src/layouts/DocsLayout.astro
  • docs/src/pages/index.astro
  • docs/src/pages/rss.xml.js
  • docs/src/plugins/remark-rewrite-links.mjs
  • docs/tests/astro-features.test.mjs
root (6 files)
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • README.md
  • README.zh.md
  • SUPPORT.md
  • samples/autonomous-pipeline/index.ts
scripts (1 file)
  • scripts/docs-site-location.mjs
squad-cli (1 file)
  • packages/squad-cli/README.md
squad-sdk (1 file)
  • packages/squad-sdk/README.md
tests (2 files)
  • test/ci/docs-quality.test.ts
  • test/docs-site-location.test.ts

⚠️ Critical Files

  • samples/autonomous-pipeline/index.ts

This report is generated automatically for every PR. See #733 for details.

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

🏗️ Architectural Review

Authoritative evidence: scanners from the PR base commit, posted by the default-branch workflow_run reporter.
Results for head commit 5739333ff57f40ffe74e2be22ef2114f5298f116.

⚠️ Architectural review: 1 warning(s), 1 info.

Severity Category Finding Files
ℹ️ info template-sync Template files changed in .github/workflows/ but not in other template locations. If these templates should stay in sync, consider updating the others too. Changed: .github/workflows/, Unchanged: templates/, .squad-templates/, packages/squad-cli/templates/
🟡 warning sweeping-refactor This PR touches 61 files (61 modified/added, 0 deleted). Large PRs are harder to review — consider splitting if possible. —

Automated architectural review — informational only.

@tamirdresher
tamirdresher marked this pull request as ready for review November 8, 2026 19:49
@tamirdresher
tamirdresher requested an auto review from Copilot November 8, 2026 19:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Docs-only PRs bypass the guard tests, and an overly broad schema exemption allows retired-site links with dotted suffixes to pass undetected.

2 open issues
2 resolved since last review

Review effort: Balanced (auto)

Comment thread scripts/docs-site-location.mjs Resolved
Comment thread test/docs-site-location.test.ts Resolved
Copilot AI added 3 commits November 8, 2026 22:47
GitHub Pages doesn't redirect after a repository transfer, so links to
bradygaster.github.io/squad now return 404.

- Astro site, RSS fallback, robots sitemap, header, footer and edit links
- Docs-site and repository links in READMEs, contributor docs, package
  READMEs, current docs pages, a sample and the pr-lifecycle skill
- test/docs-site-location.test.ts guards the site location in CI

Blog narrative, changelogs and bradygaster/squad#NNN references are
unchanged.

Closes #2405

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Review fixes for #2411.

The node --test copy of the retired-site guard in
docs/tests/astro-features.test.mjs had drifted from
test/docs-site-location.test.ts. It flagged unrelated sites such as
bradygaster.github.io/squadcaster/, exempted every path under
/schemas/implementation-provenance/, and missed protocol-relative and
upper-case links. Both guards now import one contract,
scripts/docs-site-location.mjs: the site settings, the link patterns,
the scanned files and the historical allowlist. The retired-site pattern
ends /squad at a path boundary and exempts only the exact versioned
schema ID (.../implementation-provenance/v1), not the paths below it.

The old-repository check covered only the five site-chrome files, so a
regression in any other migrated link passed. It now scans every
tracked file under the migrated paths (docs, samples, READMEs,
contributor guides and the pr-lifecycle skill). It also catches the
raw.githubusercontent.com, SSH remote, REST and gh --repo forms that the
migration rewrote. HISTORICAL_REPO_LINKS lists what stays as written:
blog posts, release notes for v1.1.0 and earlier, contributor-credit
and spec-provenance permalinks, the generated upgrade-matrix section of
upgrading.md, and three internal launch and design records. Each entry
needs a reason and must still keep a link, and none may cover a current
entry point.

test/docs-site-location.test.ts pins the settings, the pattern examples
and the allowlist behavior. Every failure names the file and line, or
the input.

Refs #2405

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Review follow-up for #2411.

The retired-site exemption for the implementation-provenance schema ID
also accepted dotted suffixes, so links such as
.../implementation-provenance/v1.json or v1.html passed both guards.
The exemption now applies only where the version ends the URL: it must
be followed by the end of the line, whitespace, one of ) " ' ` < > ],
or a # fragment, which points into the same schema. A "." counts only
as a sentence end, before whitespace or the end of the line, and a
query (v1?...) is a link. Every tracked occurrence of the ID still
passes, and new pattern cases cover the .json, .html, query and
fragment forms.

Pull requests that change only docs paths skip the squad-ci test job,
which is where test/docs-site-location.test.ts runs. docs-quality now
also runs node --test docs/tests/astro-features.test.mjs. The suite
needs only Node built-ins, so the step runs before any npm install.
test/ci/docs-quality.test.ts pins that step, the suite's import of the
shared guard, and docs-quality running for docs-only pull requests.

Refs #2405

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@tamirdresher
tamirdresher force-pushed the squad/2405-docs-site-github-github-com branch from 2c403c8 to 5739333 Compare November 8, 2026 20:53
@tamirdresher
tamirdresher requested an auto review from Copilot November 8, 2026 20:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain for the documentation-site and repository-link migration.

No open issues 🎉

2 resolved since last review

Review effort: Balanced (auto)

@tamirdresher
tamirdresher merged commit 9c6fb7c into dev Nov 8, 2026
31 of 41 checks passed
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.

Repo move: docs site moved to github.github.com/squad; fix 404 links and repo links

3 participants