chore: take theme v3.0.0 - #78
Merged
Merged
Conversation
The Launch control is opt-in from v3.0.0 and nothing is derived from
`project.github` any more, so this bump alone removes the dead Launch
button: it pointed at QuantEcon/lecture-wasm.notebooks, which does not
exist. No launch options are set here, and a comment records that this is
deliberate rather than an omission.
`site_url` is new. The theme emits the canonical link, `og:url` and an
absolute `og:image` only when it is set, and this site is served under a
sub-path -- which is exactly the case v3.0.0's base-URL work addresses, so
the value carries the sub-path.
The licence footer now comes from the theme by default. This repo declares
no footer part, so it gains the CC BY-SA notice and the QuantEcon credit
with no configuration at all.
`short_path.md` loses its `{raw} jupyter` notebook-header block, rewritten
out by the theme repo's `scripts/rewrite-raw-blocks.mjs`: mystmd renders no
`raw` node, so that block's own source was reaching readers as escaped text
under the page title.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
❌ Deploy Preview for beautiful-dodol-cb9543 failed.
|
There was a problem hiding this comment.
🟢 Approval recommended
Changes are small, consistent with the theme v3.0.0 migration expectations, and the updated config/content appears valid and intentional.
Pull request overview
Updates the lecture site to QuantEcon’s Myst theme v3.0.0 and applies the associated migration cleanups needed for parity and correct behavior when the site is served from a GitHub Pages sub-path.
Changes:
- Bump pinned theme asset from v2.7.0 to v3.0.0.
- Configure
site.options.site_urlso canonical/OG URLs and base-URL-aware assets resolve correctly under/lecture-wasm/. - Remove a Sphinx
{raw}HTML header block fromshort_path.mdthat mystmd does not render as intended.
File summaries
| File | Description |
|---|---|
| lectures/short_path.md | Removes the {raw} HTML notebook header block so mystmd no longer shows escaped raw content under the title. |
| lectures/myst.yml | Pins theme to v3.0.0 and sets site_url while intentionally leaving Launch options unset to avoid dead links. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
📖 Netlify Preview Ready! Preview URL: https://pr-78--beautiful-dodol-cb9543.netlify.app (bc264c6) ✨ Browse the preview at the URL above. |
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.
Takes theme v3.0.0, the release that closes the book-theme parity gate.
What changes on the site
QuantEcon/lecture-wasm.notebooks, which does not exist. v3.0.0 makes Launch opt-in and derives nothing fromproject.github, so leaving the options unset is what removes it.og:urlsite_urlenables them, plus an absoluteog:image. This site is served under a sub-path, and v3.0.0 is the release that made the favicon andmyst-theme.csslinks base-URL aware, so those stop resolving to the domain root.short_path.mdloses a block of literal markup{raw} jupyterheader was rendering as escaped HTML under the page title, because mystmd renders norawnode.The two config lines
site.options.site_urlis set tohttps://quantecon.github.io/lecture-wasm/, confirmed against the Pages API rather than assumed.No
launch_*options are set, and the file says why — so that a later reader does not "fix" the missing Launch control by pointing it at a notebooks repository that has never existed.Reviewing the preview: the canonical link looks wrong there, and that is expected
The deploy preview emits
<link rel="canonical" href="https://quantecon.github.io/short-path/">— without the/lecture-wasm/segment. That is an artefact of how previews are built, not a defect in this change.The theme reduces
site_urlto an origin (there is a unit test asserting exactly that), so the sub-path is expected to come fromBASE_URLat build time rather than from the option. Andci.ymlsetsBASE_URLonly on the GitHub Pages build — line 65, onpushtomain. The PR-preview build immediately below it omitsBASE_URLdeliberately, because the preview is served at a domain root. So the preview's canonical carries the production origin without the production sub-path.On
mainthe same page emitshttps://quantecon.github.io/lecture-wasm/short-path/.A consequence worth noting on its own: because the preview never sets
BASE_URL, it does not exercise the sub-path code paths at all — including the base-URL-aware favicon andmyst-theme.csslinks this release brings. Those are validated by the production build rather than by this preview.What the preview does confirm
Checked against the rendered
short-pathpage rather than inferred from the config: the{raw}notebook-header block is gone, the theme's default footer renders with the inline CC badge, the licence sentence and the "A theme by QuantEcon" credit, and there is no Launch control — no Colab link, nolecture-wasm.notebooksreference, no "Launch notebook" label anywhere.Also worth recording for whoever merges: the failing
netlify/…checks on this PR are pre-existing, not caused by this change. The same three Netlify checks fail on #74, #75 and #77. The GitHub Actionsbuild-and-deployjob — the one that actually produces and deploys the preview — passes, as doesdata-url-guard.The source change
lectures/short_path.mdwas rewritten by the theme repo'sscripts/rewrite-raw-blocks.mjs, which is shipped in v3.0.0 for exactly this migration. It deletes the header block and nothing else; it exits non-zero and writes nothing if it meets a{raw}block it does not recognise, and it met none here. It was the only file in the repo carrying one.🤖 Generated with Claude Code