[AAASM-4160] 🔗 (docs): Repoint doc references + mkdocs site_url to canonical host#215
Conversation
Replace GitHub-Pages doc URLs (ai-agent-assembly.github.io/*) with the canonical docs.agent-assembly.com host across README, docs pages, examples, mkdocs.yml (site_url + nav links), and the deployment-summary BASE_URL in the documentation/backfill workflows. repo_url and the gh-pages deploy mechanics are untouched; third-party github.io links are left as-is. Refs AAASM-4160
✅ Claude Code review — AAASM-4160 (python-sdk)1. CI: Green — all checks pass (4 pass); |
What changed
Repoints all GitHub-Pages documentation references (
ai-agent-assembly.github.io/*) to the canonicaldocs.agent-assembly.comhost across the Python SDK repo. Canonical mapping applied in order:ai-agent-assembly.github.io/agent-assembly-docsdocs.agent-assembly.comai-agent-assembly.github.io/agent-assemblydocs.agent-assembly.com/coreai-agent-assembly.github.io/python-sdkdocs.agent-assembly.com/python-sdkai-agent-assembly.github.io/node-sdkdocs.agent-assembly.com/node-sdkai-agent-assembly.github.io/go-sdkdocs.agent-assembly.com/go-sdkKey change:
mkdocs.ymlsite_url→https://docs.agent-assembly.com/python-sdk/(same path, canonical host). Verified the generatedindex.htmlnow emits<link rel="canonical" href="https://docs.agent-assembly.com/python-sdk/">.Files (13):
mkdocs.yml,README.md,docs/index.md,docs/configuration.md,docs/quick-start.md,docs/concepts/index.md,docs/compatibility/{index,frameworks,release-process}.md,examples/README.md,examples/type_checking/README.md,.github/workflows/documentation.yaml,.github/workflows/docs-backfill.yaml.Why
Consolidate all doc links onto the canonical host so users and search engines land on
docs.agent-assembly.comrather than the raw GitHub Pages origin. Ref Epic AAASM-4160.Scope guards
repo_url/repo_nameinmkdocs.ymlleft pointing atgithub.com/ai-agent-assembly/python-sdk(correct source repo).*.github.iolinks (google.github.io,openai.github.io,langchain-ai.github.io,mkdocstrings.github.io) untouched.BASE_URLshown in the "Deployment summary" / "Republish summary" GitHub step summaries — the actual gh-pages deploy mechanics live inscripts/ci/deploy-*-documentation.shand are unchanged.How to verify
grep -rn "ai-agent-assembly.github.io" .→ 0 residual actionable refs.uv sync --group docs && uv run mkdocs build --strict→ builds clean; canonical<link>points at the new host.Refs AAASM-4160