Skip to content

docs: Keep a Changelog rewrite + feature-parity PLAN.md#53

Merged
mmcky merged 2 commits into
mainfrom
changelog-and-feature-plan
Jun 3, 2026
Merged

docs: Keep a Changelog rewrite + feature-parity PLAN.md#53
mmcky merged 2 commits into
mainfrom
changelog-and-feature-plan

Conversation

@mmcky
Copy link
Copy Markdown
Contributor

@mmcky mmcky commented Jun 3, 2026

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 format

Reconstructed from git history + PRs and reformatted to match quantecon-book-theme (Keep a Changelog + SemVer):

2. PLAN.md → phased feature-parity plan

Maps quantecon-book-theme v0.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 build time — the theme only renders it. Each affected phase therefore has an upstream deliverable plus the theme change.

Notes / decisions for review

  • Changesets interaction: release.yml uses Changesets, which prepends to CHANGELOG.md in 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.
  • This is docs-only — no code or dependency changes.

🤖 Generated with Claude Code

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>
Copilot AI review requested due to automatic review settings June 3, 2026 23:28
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md into Keep a Changelog format with an [Unreleased] section and backfilled historical entries.
  • Adds PLAN.md describing phases 0–6 to close feature gaps vs quantecon-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.

Comment thread PLAN.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Comment thread CHANGELOG.md Outdated
- 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>
@mmcky
Copy link
Copy Markdown
Contributor Author

mmcky commented Jun 3, 2026

Addressed Copilot's 4 review comments in 96943d9 (docs-only). Threaded replies are on each comment so they can be resolved individually.

  • PLAN.md:114 (zero-width char) — Fixed. Removed the stray U+200B; now a plain commit/history slash (confirmed it was the only zero-width char in either file).
  • CHANGELOG.md:12 ("tagged from package.json") — Fixed. Reworded: the version comes from package.json and each release is a deploy commit (🚀 vX.Y.Z from <sha>) in the bundle repo; there are no git tags currently.
  • CHANGELOG.md footer links (tag URLs 404) — Deferred, not changed. The links follow the Keep a Changelog standard, which assumes vX.Y.Z tags — the real gap is that the release workflow never creates them. Added a Phase 0 task in PLAN.md to introduce release tags (retroactively at the recorded source commits + going forward), after which the links resolve.
  • CHANGELOG.md:43 (1.1.1 date) — Fixed, but with a different date than suggested. The actual release was the deploy to users on 2025-06-13 (56d1f0b in the bundle repo); every entry here is dated by deploy date. The 2026-02-25 date is when the source version-bump PR v1.1.1 #8 belatedly merged (bookkeeping). Corrected the header to 2025-06-13 and reworded the note, rather than using 2026-02-25.

@mmcky mmcky merged commit d67ee39 into main Jun 3, 2026
1 check passed
@mmcky mmcky deleted the changelog-and-feature-plan branch June 3, 2026 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants