docs: add historical release overviews - #1899
Conversation
|
Important Review skippedNo new commits to review since the last review. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdded version-specific “What’s New” pages for seven Humanizer releases. Updated overlays, sidebars, validation tests, and immutability hashes. ChangesHumanizer 2 release pages
Humanizer 3 release pages
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested labels: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds release-specific “What’s New” pages to each published, versioned documentation snapshot so historical routes stop inheriting current-v4 prose, and updates navigation + immutability metadata accordingly.
Changes:
- Added
whats-new/index.mdxpages for each published snapshot version (2.10.1 → 3.0.10), with version-accurate titles, headings, and release/compare links. - Exposed the new “What’s New” page in each snapshot’s versioned sidebar as the second top-level entry.
- Added a unit test to enforce the presence/content of versioned What’s New pages and their sidebar wiring; refreshed the corresponding snapshot/sidebar SHA256 digests.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/versioned_sidebars/version-3.0.8-sidebars.json | Adds the whats-new/whats-new doc to the top of the 3.0.8 snapshot sidebar. |
| website/versioned_sidebars/version-3.0.10-sidebars.json | Adds the whats-new/whats-new doc to the top of the 3.0.10 snapshot sidebar. |
| website/versioned_sidebars/version-3.0.1-sidebars.json | Adds the whats-new/whats-new doc to the top of the 3.0.1 snapshot sidebar. |
| website/versioned_sidebars/version-2.14.1-sidebars.json | Adds the whats-new/whats-new doc to the top of the 2.14.1 snapshot sidebar. |
| website/versioned_sidebars/version-2.13.14-sidebars.json | Adds the whats-new/whats-new doc to the top of the 2.13.14 snapshot sidebar. |
| website/versioned_sidebars/version-2.11.10-sidebars.json | Adds the whats-new/whats-new doc to the top of the 2.11.10 snapshot sidebar. |
| website/versioned_sidebars/version-2.10.1-sidebars.json | Adds the whats-new/whats-new doc to the top of the 2.10.1 snapshot sidebar. |
| website/versioned_docs/version-3.0.8/whats-new/index.mdx | New release overview page for Humanizer 3.0.8. |
| website/versioned_docs/version-3.0.10/whats-new/index.mdx | New release overview page for Humanizer 3.0.10. |
| website/versioned_docs/version-3.0.1/whats-new/index.mdx | New release overview page for Humanizer 3.0.1. |
| website/versioned_docs/version-2.14.1/whats-new/index.mdx | New release overview page for Humanizer 2.14.1. |
| website/versioned_docs/version-2.13.14/whats-new/index.mdx | New release overview page for Humanizer 2.13.14. |
| website/versioned_docs/version-2.11.10/whats-new/index.mdx | New release overview page for Humanizer 2.11.10. |
| website/versioned_docs/version-2.10.1/whats-new/index.mdx | New release overview page for Humanizer 2.10.1. |
| website/tests/versionedWhatsNew.test.mjs | Adds unit coverage ensuring each published snapshot has version-specific What’s New content and a sidebar entry. |
| website/humanizer-versions.json | Updates immutability digests for the affected frozen snapshots/sidebars after adding the new pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
6f84d54 to
e293f92
Compare
84b41c2 to
8433474
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 84334745b1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
e293f92 to
874a33c
Compare
a0e2380 to
2420799
Compare
b5583d6 to
54e8ddd
Compare
2420799 to
11c3c6d
Compare
|
[codex] Rebased onto the #1898 merge with frozen raw patch hash |
|
✅ Action performedReview finished.
|
Summary
Each published documentation snapshot now has its own release-specific What's New page and sidebar entry, so historical routes describe that exact release instead of inheriting current-v4 prose. The immutable manifest was refreshed only for the seven snapshot/sidebar digests changed by these pages. Byte-identical overlay replacements let snapshot release and rollback transactions reproduce those immutable pages.
This PR is rebased directly onto
mainafter #1898 merged, preserving the final current-v4 and historical release-route sequence without a stacked base.Validation
pwsh ./tools/docs/verify-manifest.ps1— passed after rebase.pnpm --dir website run test:unit— 54/54 passed.pnpm --dir website run check:content— all seven areas passed.pnpm --dir website run typecheck— passed.9db292973ce3c3d01cc485606960598d4034454315cf1210286fc90b96a1a142before and after rebase.99ab3a3a60c84249b95f62594a3e7b1218aa30aabefore and after rebase.git diff --check— passed.Checklist
mainafter docs: add Humanizer 4 release guides #1898 merged.