Skip to content

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

Draft
tamirdresher wants to merge 1 commit into
devfrom
squad/2405-docs-site-github-github-com
Draft

tamirdresher wants to merge 1 commit into
devfrom
squad/2405-docs-site-github-github-com

Conversation

@tamirdresher

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 test/docs-site-location.test.ts so CI fails if the site location or old docs-host links come back.

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
  • 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 question 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.

Size (>20 files): 58 files of mechanical link updates:

  • 35 docs pages and 2 blog posts
  • 8 site config and component files
  • 7 READMEs and contributor docs
  • 2 docs notes, a skill, a sample, and 2 tests

All are the same kind of change and the new test guards them, so splitting them further wouldn't make review easier.

Validation (branch on its own, Windows, Node 27):

Command Result
npx vitest run test/docs-site-location.test.ts test/docs-links.test.ts ✅ 2 files, 10 passed
node --test tests/astro-features.test.mjs (in docs/) ✅ 24/24
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
Red proof: guard run against pre-change content ✅ 6 tests fail, each naming the offending file and line

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 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>
@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 05ba0b9

PR Scope: 🔧 Infrastructure

⚠️ 3 item(s) to address before review

Status Check Details
✅ Single commit 1 commit — clean history
❌ Not in draft PR is still in draft — mark as ready for review when done
✅ 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 No Copilot review threads
❌ CI passing 1 check(s) failing: test

Files Changed (58 files, +424 −180)

File +/−
.copilot/skills/pr-lifecycle/SKILL.md +3 −3
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
docs/src/layouts/DocsLayout.astro +1 −1
... +8 more files

Total: +424 −180


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

This branch has not been deployed

No deployments
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

2 participants