docs(examples): regroup the gallery by computational task - #500
Draft
lkdvos wants to merge 1 commit into
Draft
Conversation
`quantum1d` and `classic2d` grouped by the physics of the model, which is not how a reader
arrives: they come with a task ("I need a ground state", "I need finite temperature") and
have to open every example to find out which one does it. Regroup into `groundstates`,
`excitations`, `dynamics` and `statmech`, and give the gallery index a one-paragraph summary
per example so it can be scanned.
`examples/make.jl` now discovers groups by listing its own subdirectories instead of naming
them, so adding a group needs no pipeline change. The gallery sidebar in `docs/make.jl`
mirrors the same grouping.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This was referenced Aug 3, 2026
Contributor
|
After the build completes, the updated documentation will be available here |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Split out of #449 so it can be reviewed on its own. #449 depends on this one (its landing page and symmetry tutorial link to the regrouped example paths and to the new
examples_indexanchor), so this should merge first.quantum1dandclassic2dgrouped examples by the physics of the model, which is not how a reader arrives: they come with a task ("I need a ground state", "I need finite temperature") and have to open every example to find out which one does it. Regrouped intogroundstates,excitations,dynamicsandstatmech, with a one-paragraph summary per example in the gallery index so it can be scanned.examples/make.jlnow discovers groups by listing its own subdirectories instead of naming them, so adding a group needs no pipeline change.Review notes
examples/make.jl, the galleryindex.md, and the regenerated page diffs.main; the committed pages are that output. Numbers moved in the last digits andgroundstates/1.xxz-heisenbergconverged to a slightly different VUMPS fixed point (41 → 60 iterations). No prose quotes an affected value.correlation_length(...; sector = leftunit(ψ))update already present in themain.jlfiles.examples/make.jlnow normalizes source locations in captured log output. Rendered pages previously embedded the absolute checkout path and depot slug of whoever ran the pipeline (maincurrently ships adocs-improvement-planworktree path), so the output differed per machine. Now└ @ MPSKit src/algorithms/groundstate/vumps.jl:87.🤖 Generated with Claude Code