[AAASM-4558] ✨ (python-sdk-docs): Convert troubleshooting pip/uv alternative to tabs - #246
Conversation
Mirrors the pymdownx.tabbed pattern already used in quick-start.md so the two alternative ways to enable the native runtime render as selectable tabs instead of a single ambiguous bash block.
Review: AAASM-4558 — troubleshooting pip/uv tabsCI: 2/5 checks passed, 0 failed. The 3 missing checks are expected — this repo's Scope: Regression check: Both commands are preserved verbatim:
One small, intentional-looking edit: the pip line's trailing comment changed from Playwright validation: Built the PR branch with
This repo has a Verdict: READYNo blocking issues. CI is clean (modulo the expected docs-path skip), the diff is scoped exactly to the ticket, both commands are preserved verbatim, and the tabs render/switch correctly in a live build. — Claude Code |
Claude Code review — AAASM-45581. CI: Green. 2. Scope vs subtask: Delivers the AC exactly — the plain bash block at 3. Side effects: Docs-only — one file, 4. FE (rendered tabs → headless Chromium): Built the combined site and drove it. Tab labels render as Overall: ✅ Ready to merge. Meets AC, docs-only, CI green, tabs render + switch correctly. — Claude Code |
Description
docs/troubleshooting.md's "The native extension isn't loading" section showedthe pip-install and
uv tool run maturin developalternatives as one plainbash block, which reads as "run both" rather than "pick one." Converted to
mkdocs-material content tabs (
=== "pip"/=== "uv"), mirroring the exacttab pattern already used in
docs/quick-start.md(pymdownx.tabbed withalternate_style: trueis already enabled inmkdocs.yml).Type of Change
Breaking Changes
Related Issues
Testing
Validated with
uv sync --group docs+.venv/bin/python -m mkdocs build --strict(exit 0) and confirmed the rendered
site/troubleshooting/index.htmlcontainsthe expected
tabbed-setwith "pip" / "uv" labels.Checklist
Note: this repo's CI
pathsallow-list excludesdocs/**, so no CI workflowruns on this docs-only PR (expected per repo convention — review-required,
not a CI failure).