docs(examples): regroup the gallery by computational task - #500
Draft
lkdvos wants to merge 2 commits into
Draft
Conversation
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:
|
lkdvos
force-pushed
the
docs/examples-regroup
branch
from
August 5, 2026 13:52
85ed22b to
ba92131
Compare
`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.
Drop the `N.` prefix from the example folders as well. The folder name is the published URL,
so a numeric prefix means inserting one example renames — and breaks the URL of — every
example after it, in order to express an ordering these examples do not really have. The
reading order now lives in the gallery index summaries, which run from introductory to
advanced; the sidebar is alphabetical within each group. `examples/README.md` documents this
for contributors.
`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>
lkdvos
force-pushed
the
docs/examples-regroup
branch
from
August 5, 2026 14:17
ba92131 to
ff58ac4
Compare
Hide precompilation output. A `using` block reports precompilation progress whenever the
pipeline runs against a cold depot, which says nothing about the example and whose timings
differ per machine. `examples/make.jl` now drops any captured-output block that contains
nothing else, and the twelve blocks that had been committed across four pages are gone.
Use unicode in the markdown, not just in the code. Symbol macros become characters
(`\beta` -> β, `\langle`/`\rangle` -> ⟨⟩, `\dagger` -> †, `\ket{ψ}` -> |ψ⟩, `\hat{a}` -> â),
while structural LaTeX stays: `\frac`, `\sum` with limits, `\sqrt`, `\vec`, environments, and
`\hat{n}`, which has no precomposed character. `\left`/`\right` keep their macro delimiters,
since they need a LaTeX delimiter to size.
Format the example markdown one sentence per line, leaving lists, tables, display math,
admonitions and fenced blocks alone.
Rework the gallery index. "Level"/difficulty becomes the more neutral "Complexity"; the
ground states now open with the introductory Ising CFT example instead of the XXZ one; the
XXZ summary describes choosing a unit cell and symmetry to suit the state, with the transfer
and entanglement spectra as diagnostics, rather than a search that goes wrong; and the
summaries no longer name functions or symmetry types, which belong on the pages themselves.
The prose edits were applied to both `main.jl` and its rendered page so that a prose-only
change stays a prose-only diff instead of re-running every example for new digits. Rendering
all nine sources through Literate with `execute = false` reproduces the committed pages'
prose exactly, the notebooks were regenerated, and `Cache.toml` is back in sync.
Along the way: `xy-finiteT` had two overlapping sentences where one had lost its terminating
period, the Hubbard prose said `\mu = 0` where its equations already used μ, and four
misspellings sat in lines this pass rewrites anyway.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.Example folders also lost their
N.prefix:quantum1d/4.xxz-heisenbergis nowgroundstates/xxz-heisenberg. The folder name is the published URL, so a numeric prefix means inserting one example renames — and breaks the URL of — every example after it, to express an ordering these examples do not really have. Reading order now lives in the gallery index summaries, which are still arranged from introductory to advanced; the sidebar is alphabetical within each group.examples/README.mddocuments this for contributors.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/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.groundstates/tfim-groundstateandexcitations/su3-heisenberg) are deliberately not here — they are new content, not a regrouping — so this PR's gallery index describes eight examples where docs: Diátaxis restructure — tutorials, how-to guides, concepts, library reference #449's describes ten.🤖 Generated with Claude Code