Skip to content

[AAASM-4559] ✨ (python-sdk-docs): Convert container-base-image docker build variants to tabs - #245

Merged
Chisanan232 merged 1 commit into
masterfrom
v0.1.0/AAASM-4559/docs/docker_build_tabs
Jul 13, 2026
Merged

[AAASM-4559] ✨ (python-sdk-docs): Convert container-base-image docker build variants to tabs#245
Chisanan232 merged 1 commit into
masterfrom
v0.1.0/AAASM-4559/docs/docker_build_tabs

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

Description

Convert the two alternative docker build invocations in docs/guides/container-base-image.md (default vs. --build-arg SDK_VERSION=... pinned) from a single plain bash block into mkdocs-material content tabs (=== "Default" / === "Pinned version"), mirroring the tab pattern already used in docs/quick-start.md.

Type of Change

  • ✨ New feature
  • 🔧 Bug fix
  • ♻️ Refactoring
  • 📚 Documentation update
  • 🍀 Performance improvement
  • 🚀 Release

Breaking Changes

  • No
  • Yes (please describe below)

Related Issues

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No tests required (explain why)

Verified locally with .venv/bin/mkdocs build --strict (after uv sync --group docs in a fresh worktree) — build succeeds with exit code 0, no strict-mode warnings/errors introduced by this change.

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Comments added for complex logic
  • Documentation updated if needed
  • All tests passing (docs-only change; ci.yaml excludes docs/** from CI per repo convention — this PR is review-required, not CI-gated)

…ts to tabs

Mirror the pymdownx.tabbed pattern used in quick-start.md so the default
vs. pinned-version docker build invocations render as separate tabs
instead of one plain bash block.
@Chisanan232

Copy link
Copy Markdown
Contributor Author

Review: CI / scope / regression / Playwright

CI status — 1 check was initially failing: Build documentation (PR, no deploy) had conclusion: cancelled (not a code failure — the job was cancelled ~13s after starting, before any log output, while sibling docs-only PRs opened in the same window (#244/#246, master) built successfully with the same workflow). This looks like a transient CI runner/infra flake, not something caused by this diff. Reran the workflow (gh run rerun 29247026035) and it completed successfully on the second attempt. Current state: Build documentation (PR, no deploy) ✅ success, Analyze (python) ✅ success. No commits were needed to fix this — nothing in the diff caused it.

Scope verdict: READY. gh pr diff 245 shows exactly one file changed, docs/guides/container-base-image.md, +12/-6 lines. The change is precisely the described conversion: the single plain bash block containing both docker build invocations becomes two mkdocs-material content tabs (=== "Default" / === "Pinned version"), matching the === "pip" / === "uv" tab pattern in docs/quick-start.md:14-25. Nothing else in the file was touched.

Regression verdict: READY. Both commands are preserved verbatim in their new tabs:

  • Default: docker build -t my-agent .
  • Pinned: docker build --build-arg SDK_VERSION=0.0.1b5 -t my-agent . (exact pinned version string 0.0.1b5 unchanged)

The only textual change is dropping the now-redundant Default — prefix from the first command's comment (# Default — let the image resolve...# Let the image resolve...), since the tab label itself now says "Default" — a sensible copy-editing choice consistent with how quick-start.md's tabs don't repeat the tab title in the code comment. All surrounding prose (the SDK_VERSION table, the "Published images already pin the SDK" tip, "Best practices" section) is byte-for-byte unchanged.

Playwright validation: PASS. Built the docs locally (uv sync --group docs && uv run mkdocs build --strict — succeeded, no strict-mode warnings/errors from this change) and served the built site/ directory. Note: the shared Playwright MCP browser session was being concurrently driven by other sessions (tabs kept appearing/disappearing mid-navigation), so I fell back to a standalone Playwright script against the local build to get a clean, isolated verification:

  • Navigated to /guides/container-base-image/. "Default" tab renders active by default, showing docker build -t my-agent ..
  • Clicked "Pinned version" — content switched correctly to docker build --build-arg SDK_VERSION=0.0.1b5 -t my-agent .. Confirmed via screenshot and text-visibility assertions for both states.

Overall verdict: READY

No blocking issues. CI is green (after a rerun of an unrelated transient cancellation), the diff is scoped exactly to the ticket, both build-arg examples are preserved verbatim, and the tabs render and switch correctly in a real browser build.

— Claude Code

@Chisanan232

Copy link
Copy Markdown
Contributor Author

Claude Code review — AAASM-4559

1. CI: Green. Analyze (python) pass, Build documentation (PR, no deploy) pass; Deploy … jobs correctly skipping (push-to-master only). No failures.

2. Scope vs subtask: Delivers the AC exactly — the plain bash block at docs/guides/container-base-image.md:101-110 (default vs. pinned --build-arg SDK_VERSION=… docker builds) is converted to === "Default" / === "Pinned version" content tabs. The now-redundant "Default —" / "Pin an exact…" lead-in comments are trimmed appropriately. Ready.

3. Side effects: Docs-only — one file, docs/guides/container-base-image.md (+12/-6). No agent_assembly/ runtime code touched. mkdocs build --strict (combined-branch build) exits 0, no strict warnings.

4. FE (rendered tabs → headless Chromium): Tab labels render as [Default, Pinned version]; switching to Pinned version flips the radio state to [false, true] and the visible block becomes docker build --build-arg SDK_VERSION=0.0.1b5 -t my-agent .; Default shows docker build -t my-agent .. Switch works. Screenshots: design/validation/AAASM-4548-python/container-default-tab.png + container-pinned-tab.png.

Overall: ✅ Ready to merge. Meets AC, docs-only, CI green, tabs render + switch correctly.

— Claude Code

@Chisanan232
Chisanan232 merged commit e388d0f into master Jul 13, 2026
8 of 9 checks passed
@Chisanan232
Chisanan232 deleted the v0.1.0/AAASM-4559/docs/docker_build_tabs branch July 13, 2026 12:34
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