docs: Keep a Changelog rewrite + feature-parity PLAN.md#53
Merged
Conversation
Rework CHANGELOG.md into Keep a Changelog / SemVer format to match quantecon-book-theme, reconstructed from git history and PRs: - Add an [Unreleased] section capturing the post-1.1.1 work that is in main but not yet deployed (@myst-theme 0.14 -> 1.1.2, Remix 1.17 -> 1.19, Node >=18, CI, a11y fixes, security overrides). Proposed as 1.2.0. - Backfill 1.0.0 -> 1.1.1 with grouped Added/Changed/Fixed entries and dates, plus compare links. Add PLAN.md: a phased plan to reach feature parity with quantecon-book-theme (v0.20.3) ahead of the JB>=2 lecture migration. Covers the build-time-vs-runtime constraint (theme cannot run git, so git-derived data must be injected via a MyST plugin), a feature-gap matrix, and Phases 0-6 (release hygiene; git history in headers; launch parity; code/colour theming; i18n; RTL; meta/SEO/docs). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This documentation-only PR prepares for migrating QuantEcon lectures to Jupyter Book/MyST ≥ 2 by (1) standardizing the project changelog into a Keep a Changelog + SemVer structure and (2) adding a phased roadmap to reach feature parity with quantecon-book-theme.
Changes:
- Rewrites
CHANGELOG.mdinto Keep a Changelog format with an[Unreleased]section and backfilled historical entries. - Adds
PLAN.mddescribing phases 0–6 to close feature gaps vsquantecon-book-theme, including build-time vs runtime constraints and upstream plugin needs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
PLAN.md |
New phased feature-parity plan and architectural constraints for build-time git-derived metadata. |
CHANGELOG.md |
Keep a Changelog rewrite with unreleased + historical entries and reference links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- PLAN.md: remove a stray U+200B zero-width space in "commit/history" - CHANGELOG.md: reword the release-flow note — versions come from package.json and ship as bundle deploy commits; there are no git tags - CHANGELOG.md: date 1.1.1 by its actual deploy (2025-06-13) and clarify that the 2026-02-25 source PR merge was bookkeeping, not a re-release - PLAN.md: add a Phase 0 task to introduce git release tags so the Keep-a-Changelog footer compare links resolve (deferred from this PR) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
Addressed Copilot's 4 review comments in 96943d9 (docs-only). Threaded replies are on each comment so they can be resolved individually.
|
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
Documentation-only PR with two deliverables from a deep review of the theme and a comparison against
quantecon-book-theme, ahead of migrating the QuantEcon lectures to Jupyter Book ≥ 2.1.
CHANGELOG.md→ Keep a Changelog formatReconstructed from git history + PRs and reformatted to match
quantecon-book-theme(Keep a Changelog + SemVer):[Unreleased]section capturing the post-1.1.1 work that is inmainbut not yet deployed toQuantEcon/quantecon-theme(still v1.1.1):@myst-theme0.14→1.1.2 (Upgrade @myst-theme/* from 0.14.x to 1.1.2 #30), Remix 1.17→1.19 (Fix CI: bump @remix-run/* from 1.17 to 1.19 (peer dependency conflict) #29), Node>=18+ CI + a11y fixes (fix: quick wins from technical review (bugs, CI, Node, docs) #31, fix: resolve CI type-check errors (lodash types, Buffer→Uint8Array) #32), security overrides. Proposed release: 1.2.0.1.0.0→1.1.1with groupedAdded/Changed/Fixedentries, dates, and compare links.2.
PLAN.md→ phased feature-parity planMaps
quantecon-book-themev0.20.3 features against this theme and lays out Phases 0–6.Headline gap (flagship Phase 1): git history in lecture headers ("Last changed" + changelog dropdown).
Key architectural call-out: the MyST theme is a runtime Remix server with no access to the git repo, so git-derived data must be injected upstream via a MyST plugin at
myst buildtime — the theme only renders it. Each affected phase therefore has an upstream deliverable plus the theme change.Notes / decisions for review
release.ymluses Changesets, which prepends toCHANGELOG.mdin its own format. This hand-maintained Keep a Changelog file will need a decision (reconcile formats, or move the changelog to manual). Tracked as a Phase 0 item.🤖 Generated with Claude Code