Skip to content

docs: consolidate tutorials into the Python Quick Start - #80

Merged
Roger-luo merged 1 commit into
mainfrom
docs/consolidate-python-quickstart
May 18, 2026
Merged

Roger-luo merged 1 commit into
mainfrom
docs/consolidate-python-quickstart

Conversation

@Roger-luo

@Roger-luo Roger-luo commented May 18, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Fold the standalone Tutorials section into the Python Quick Start — same audience, same code, partially overlapping content. Python users now have one guided path: Install → Stim → Tableau → Pauli Propagation → Loss channel → Next steps.
  • Extend Base.astro with optional sections / currentSection props that render a 3-column shell (section nav on the left, content in the middle, per-section TOC on the right). Pages that only pass toc keep the existing 2-column layout untouched.
  • Split quickstart/python.astro into six pages under quickstart/python/; the tutorials' content moves into the matching sections. The top-nav "Tutorials" entry is removed and section ordering lives in src/data/pyQuickStart.ts.

Test plan

  • npm run astro:build — all 14 routes build cleanly, including the six new quickstart/python/* pages.
  • Rendered HTML contains .page-shell--3col + .page-sections + .page-toc--right on each section page, with aria-current="page" correctly set on the active section link.
  • Visually verify the dual sidebars in light + dark themes via npm run astro:dev.
  • Verify the responsive collapse: right TOC drops at <1100px, section list wraps horizontally at <900px.

🤖 Generated with Claude Code

The previous "Tutorials" section was effectively an extended Python
Quick Start — same audience, same code, partially overlapping content.
Fold it in so there is a single guided path for Python users.

- Extend Base.astro with optional `sections` / `currentSection` props
  that render a 3-column shell: section nav (left), content,
  per-section TOC (right). Single-`toc` pages keep the existing
  2-column layout.
- Split quickstart/python.astro into six pages under quickstart/python/
  (install, stim, tableau, pauli-propagation, loss-channel,
  next-steps); merge the matching tutorials into the tableau,
  pauli-propagation, and loss-channel sections.
- Remove the tutorials route and its top-nav entry; section ordering
  is centralised in src/data/pyQuickStart.ts.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 18, 2026 17:13
@github-actions

github-actions Bot commented May 18, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-05-18 17:18 UTC

@Roger-luo
Roger-luo merged commit 2d84e53 into main May 18, 2026
10 checks passed
@Roger-luo
Roger-luo deleted the docs/consolidate-python-quickstart branch May 18, 2026 17:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR consolidates the former “Tutorials” content into a single guided Python Quick Start path, and introduces an optional 3‑column documentation layout (left section nav + main content + right per-page TOC) to support the new multi-page Quick Start structure.

Changes:

  • Added optional sections / currentSection support to Base.astro and new CSS to render a 3‑column page shell.
  • Split the Python Quick Start into multiple pages under quickstart/python/, with a shared left-hand section index (pyQuickStartSections).
  • Removed the standalone Tutorials landing page and the “Tutorials” top-nav entry.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/src/styles/global.css Adds 3‑column shell + responsive behavior for section nav (left) and TOC (right).
docs/src/layouts/Base.astro Adds sections rendering path and removes “Tutorials” from the header nav.
docs/src/pages/tutorials/index.astro Removes Tutorials landing page.
docs/src/pages/quickstart/python.astro Removes the previous single-page Python Quick Start.
docs/src/pages/quickstart/index.astro Updates Python Quick Start bullet list to match the consolidated path.
docs/src/pages/quickstart/python/index.astro New §1 install/verify landing page for the Python Quick Start.
docs/src/pages/quickstart/python/stim.astro New §2 page: Stim circuits & sampling.
docs/src/pages/quickstart/python/tableau.astro Updates §3 page: Generalized Tableau, now within the sectioned Quick Start layout.
docs/src/pages/quickstart/python/pauli-propagation.astro Updates §4 page: Pauli propagation; adds a GHZ end-to-end example block.
docs/src/pages/quickstart/python/loss-channel.astro Updates §5 page: loss-channel mathematical background; updates cross-links.
docs/src/pages/quickstart/python/next-steps.astro New §6 “Next steps” page, with cross-link to Rust Quick Start.
docs/src/data/pyQuickStart.ts Centralizes Python Quick Start section ordering/labels/links for the left nav.
Comments suppressed due to low confidence (1)

docs/src/pages/quickstart/python/tableau.astro:120

  • The text recommends using copy.copy() to preserve RNG state, but the surrounding examples/snippets don’t import the standard-library copy module. Consider adding import copy in the relevant snippet (or adjusting the prose to mention it) so copy/paste works without a NameError.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants