Repository navigation
docs: move docs site to github.github.com/squad and update repo links - #2411
Conversation
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| 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.
There was a problem hiding this comment.
🟡 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.ailinks 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)
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>
05ba0b9 to
2c403c8
Compare
🔴 Impact Analysis — PR #2411Risk tier: 🔴 CRITICAL 📊 Summary
🎯 Risk Factors
📦 Modules Affectedci-workflows (1 file)
copilot-config (1 file)
docs (48 files)
root (6 files)
scripts (1 file)
squad-cli (1 file)
squad-sdk (1 file)
tests (2 files)
|
🏗️ Architectural Review
Automated architectural review — informational only. |
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>
2c403c8 to
5739333
Compare


What
https://github.github.com/squad/. This covers the Astrosite(base: '/squad/'is unchanged), the RSS fallback, the robots.txt sitemap (it pointed at the parkedsquad.devdomain), and the header, footer, home page, link-rewrite plugin, and "Edit this page" URLs.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.scripts/docs-site-location.mjs. Bothtest/docs-site-location.test.ts(in thetestjob) and the docsnode --testsuite use it, and thedocs-qualityjob 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/squadnow return 404. Contributor instructions (fork URL, upstream remote,gh pr create --repo) still named the old repository.Closes #2405
How
npx github:…#insiderinstruction, which now usesnpm i -g @bradygaster/squad-cli@insider.bradygaster/squad#NNNreferencesscripts/docs-site-location.mjs):The Astro
siteandbase, 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/vNis 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 asv1.jsonorv1.html, and?queries are links.Every tracked file under
docs/andsamples/, plus the READMEs, contributor guides and the pr-lifecycle skill, is scanned for the old repository in web, raw, SSH, REST (repos/) andgh --repoforms. A failure lists eachfile:line: link.Historical records keep their links through an allowlist where each entry states a reason:
whatsnew.mdfrom## v1.1.0downdocs/specification/upgrading.mddocs/_internal/recordsA 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
testjob, sodocs-qualityinsquad-ci.ymlalso runsnode --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.tsfails if the step is removed, if the suite stops importing the guard, or ifdocs-qualitystops running for docs-only PRs.README.md,docs/.../guide/gh-aw.md, anddocs/.../features/standalone-install.mdalso 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.ghcr.io/bradygaster/squad-cliandsquad-external-scaler, but no workflow publishes either image. Publish them under the new owner, or document building from theDockerfile.docs-qualityisn't a required check ondev; onlytestandgh-aw strict compileare, and a skippedtestjob counts as passing. Untildocs-qualityis 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.
scripts/docs-site-location.mjsand its 2 tests, plus thedocs-qualitystep in.github/workflows/squad-ci.ymland its contract testtest/ci/docs-quality.test.tsThe 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:
npx vitest run test/docs-site-location.test.ts test/docs-links.test.tsnode --test tests/astro-features.test.mjs(indocs/)npx eslint test/docs-site-location.test.ts scripts/docs-site-location.mjsCONTRIBUTING.md,README.md, and the current parts ofwhatsnew.md,upgrading.mdandcontributors.md) fail both runners, and the message namesfile: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 testsSecond review round (
5739333f, rebased ondev0444041c):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.tsnode --test test/ci-concurrency.test.cjs test/workflows.test.cjsnode --test docs/tests/astro-features.test.mjs(repo root, the new CI step)docs-qualityjob also runs it on Node 22.23.4 withoutnode_modulesnpx eslinton the guard module and its three test filesactionlint1.7.12 onsquad-ci.yml"[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 limitingdocs-qualityto push each fails one named testsquad-ci.yml, run before and after the changemigrate-directory22/22,recast-identity-neutrality22/22,standalone-release-workflow43/43,test/cli/init18/18. The gh-aw suites and the twotest/cli/upgrade-*suites fail the same tests both times, for local reasons: no gh-aw binary,jqdifferences, a Windows autocrlf assertion, andnpxvsnode.exeThese checks ran before the review fixes. Neither fix commit changes docs content; they change only the guard, its tests and the
docs-qualitystep:markdownlint-cli2on the docs content and READMEcspellon the same filesnpm ci && npm run build && npm run test:build(indocs/)dist/, the sitemap,robots.txt, RSS item links, and everyog:urlusehttps://github.github.com/squad/. The only old-host strings left are 2 blog link texts (their targets are updated) and the provenance schema IDThe PR checks don't build the Astro site;
squad-docs.ymlbuilds and deploys it on push todev. The local build above covers that.The other repo-move PRs are #2406, #2407, #2403, and #2404 (issues).
npx changeset add/.changeset/*.md, directCHANGELOG.mdentry for maintainers, orskip-changeloglabel for no user-facing changes): N/A, no SDK/CLI source changesPR Readiness Checklist
Branch & Commit
dev(notmain)dev(git fetch upstream && git rebase upstream/dev)git diff --cached --stat)Build & Test
npm run buildpasses: no package source changes (build verified on the combined repo-move tree)npm testpasses (all tests green): targeted suites above; the full suite runs in CInpm run lintpasses (type check clean)npm run lint:eslintpassesChangeset
npx changeset add(ifpackages/squad-sdk/src/orpackages/squad-cli/src/changed): N/ACHANGELOG.mdentry (maintainers only — write-protected for external contributors)skip-changeloglabel applied (if no user-facing changes)Docs
Exports
Breaking Changes
None.
Waivers
None.