Repository navigation
docs: consolidate tutorials into the Python Quick Start - #80
Merged
Merged
Conversation
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>
|
Contributor
There was a problem hiding this comment.
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/currentSectionsupport toBase.astroand 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-librarycopymodule. Consider addingimport copyin 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Base.astrowith optionalsections/currentSectionprops that render a 3-column shell (section nav on the left, content in the middle, per-section TOC on the right). Pages that only passtockeep the existing 2-column layout untouched.quickstart/python.astrointo six pages underquickstart/python/; the tutorials' content moves into the matching sections. The top-nav "Tutorials" entry is removed and section ordering lives insrc/data/pyQuickStart.ts.Test plan
npm run astro:build— all 14 routes build cleanly, including the six newquickstart/python/*pages..page-shell--3col+.page-sections+.page-toc--righton each section page, witharia-current="page"correctly set on the active section link.npm run astro:dev.🤖 Generated with Claude Code