Skip to content

[AAASM-4160] 🔗 (docs): Repoint doc references + mkdocs site_url to canonical host#215

Merged
Chisanan232 merged 1 commit into
masterfrom
v0.0.1/AAASM-4160/docs/repoint_canonical_host
Jul 5, 2026
Merged

[AAASM-4160] 🔗 (docs): Repoint doc references + mkdocs site_url to canonical host#215
Chisanan232 merged 1 commit into
masterfrom
v0.0.1/AAASM-4160/docs/repoint_canonical_host

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

What changed

Repoints all GitHub-Pages documentation references (ai-agent-assembly.github.io/*) to the canonical docs.agent-assembly.com host across the Python SDK repo. Canonical mapping applied in order:

From To
ai-agent-assembly.github.io/agent-assembly-docs docs.agent-assembly.com
ai-agent-assembly.github.io/agent-assembly docs.agent-assembly.com/core
ai-agent-assembly.github.io/python-sdk docs.agent-assembly.com/python-sdk
ai-agent-assembly.github.io/node-sdk docs.agent-assembly.com/node-sdk
ai-agent-assembly.github.io/go-sdk docs.agent-assembly.com/go-sdk

Key change: mkdocs.yml site_urlhttps://docs.agent-assembly.com/python-sdk/ (same path, canonical host). Verified the generated index.html now 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.com rather than the raw GitHub Pages origin. Ref Epic AAASM-4160.

Scope guards

  • repo_url / repo_name in mkdocs.yml left pointing at github.com/ai-agent-assembly/python-sdk (correct source repo).
  • Third-party *.github.io links (google.github.io, openai.github.io, langchain-ai.github.io, mkdocstrings.github.io) untouched.
  • Workflow changes touch only the display-only BASE_URL shown in the "Deployment summary" / "Republish summary" GitHub step summaries — the actual gh-pages deploy mechanics live in scripts/ci/deploy-*-documentation.sh and 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

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
@Chisanan232

Copy link
Copy Markdown
Contributor Author

✅ Claude Code review — AAASM-4160 (python-sdk)

1. CI: Green — all checks pass (4 pass); skipping = release/deploy-conditional jobs. mergeStateStatus=BLOCKED = awaiting required Pioneer approval, not a failure. MERGEABLE.
3. Side effects: None — balanced +N/-N string swaps (host/path only); no code/logic. repo_url/repo_name kept at github.com; third-party *.github.io (google/openai/langchain) preserved; 0 residual.
4. Front-end: Doc-site content/config only; build-validated (mkdocs build --strict PASSED — generated canonical tag now docs.agent-assembly.com/python-sdk/). Changed cross-site links resolve (docs.agent-assembly.com paths → 200). No UI/component code touched → Playwright adds nothing beyond the build gate.
2. Scope: 13 files incl. mkdocs.yml site_url. Flagged (reviewed, safe): the two workflow files' only edits are display-only BASE_URL summary echoes; the actual gh-pages deploy scripts are unchanged. Complete.
Verdict: ready to approve + merge. — Claude Code

@Chisanan232 Chisanan232 merged commit a2a6734 into master Jul 5, 2026
7 checks passed
@Chisanan232 Chisanan232 deleted the v0.0.1/AAASM-4160/docs/repoint_canonical_host branch July 5, 2026 12:32
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.

1 participant