Skip to content

docs: add historical release overviews - #1899

Merged
clairernovotny merged 2 commits into
mainfrom
codex/docs-historical-whats-new
Jul 31, 2026
Merged

docs: add historical release overviews#1899
clairernovotny merged 2 commits into
mainfrom
codex/docs-historical-whats-new

Conversation

@clairernovotny

@clairernovotny clairernovotny commented Jul 30, 2026

Copy link
Copy Markdown
Member

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 main after #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.
  • Frozen raw patch hash — 9db292973ce3c3d01cc485606960598d4034454315cf1210286fc90b96a1a142 before and after rebase.
  • Stable patch ID — 99ab3a3a60c84249b95f62594a3e7b1218aa30aa before and after rebase.
  • Combined-sequence snapshots, Native AOT, production build, links, artifact, search, and browser/accessibility validation — passed.
  • git diff --check — passed.

Checklist

  • Implementation is clean.
  • Repository coding standards are followed.
  • No code-analysis warnings are introduced.
  • Historical route/content behavior has unit and full snapshot coverage.
  • No copied code requires attribution.
  • Comments and XML documentation are not applicable.
  • Rebased onto main after docs: add Humanizer 4 release guides #1898 merged.
  • No issue is closed by this historical documentation unit.
  • Version-specific documentation and navigation are updated.
  • Applicable documentation gates were run.

Copilot AI review requested due to automatic review settings July 30, 2026 19:36
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 827cfb38-9ce4-4f27-93c8-2d5a91196d31

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Added “What’s New” pages for Humanizer versions 2.10.1, 2.11.10, 2.13.14, 2.14.1, 3.0.1, 3.0.8, and 3.0.10.
    • Documented new APIs, localization improvements, compatibility updates, migration guidance, analyzer changes, and bug fixes.
    • Added the release pages to each version’s documentation sidebar.
    • Updated release and comparison links and version metadata.
  • Tests

    • Added validation ensuring published versions have complete, correctly linked, preview-free release documentation.

Walkthrough

Added version-specific “What’s New” pages for seven Humanizer releases. Updated overlays, sidebars, validation tests, and immutability hashes.

Changes

Humanizer 2 release pages

Layer / File(s) Summary
Release pages and navigation
website/versioned_docs/version-2.*/whats-new/index.mdx, website/version-overrides/2.*/..., website/versioned_sidebars/version-2.*
Added release content for four Humanizer 2 versions. Configured replacement overlays and sidebar entries.
Page validation and hashes
website/tests/versionedWhatsNew.test.mjs, website/humanizer-versions.json
Validated page metadata, links, references, and sidebar placement. Updated snapshot and sidebar hashes.

Humanizer 3 release pages

Layer / File(s) Summary
Release pages and navigation
website/versioned_docs/version-3.*/whats-new/index.mdx, website/version-overrides/3.*/..., website/versioned_sidebars/version-3.*
Added release content for three Humanizer 3 versions. Configured replacement overlays and sidebar entries.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

  • Humanizr/Humanizer#1898: Adds and validates version-specific “What’s New” documentation with related overlay and sidebar updates.

Suggested labels: documentation

Poem

A rabbit checks each release page,
With tidy links from age to age.
Sidebars hop into their place,
Hashes guard the docs with grace.
“What’s new?” now shines bright and clear—
Seven versions welcome here!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main change: adding historical release overviews to the documentation.
Description check ✅ Passed The description directly explains the release-specific pages, sidebar entries, manifest updates, and validation results.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-historical-whats-new

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.mdx pages 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.

@clairernovotny
clairernovotny force-pushed the codex/docs-v4-release-guides branch from 6f84d54 to e293f92 Compare July 30, 2026 19:50
@clairernovotny
clairernovotny force-pushed the codex/docs-historical-whats-new branch from 84b41c2 to 8433474 Compare July 30, 2026 19:50

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread website/versioned_docs/version-2.10.1/whats-new/index.mdx
@clairernovotny
clairernovotny force-pushed the codex/docs-v4-release-guides branch from e293f92 to 874a33c Compare July 30, 2026 20:32
@clairernovotny
clairernovotny force-pushed the codex/docs-historical-whats-new branch from a0e2380 to 2420799 Compare July 30, 2026 20:32
@clairernovotny
clairernovotny force-pushed the codex/docs-v4-release-guides branch from b5583d6 to 54e8ddd Compare July 31, 2026 20:17
@clairernovotny
clairernovotny changed the base branch from codex/docs-v4-release-guides to main July 31, 2026 20:37
@clairernovotny
clairernovotny force-pushed the codex/docs-historical-whats-new branch from 2420799 to 11c3c6d Compare July 31, 2026 20:38
@clairernovotny

Copy link
Copy Markdown
Member Author

[codex] Rebased onto the #1898 merge with frozen raw patch hash 9db292973ce3c3d01cc485606960598d4034454315cf1210286fc90b96a1a142 unchanged. The historical overlay registration fix remains present for all seven versions; manifest, 54/54 unit tests, content, typecheck, and diff checks pass.\n\n@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

@clairernovotny I will review the rebased changes and the historical overlay registrations.

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@clairernovotny
clairernovotny merged commit 138383c into main Jul 31, 2026
17 checks passed
@clairernovotny
clairernovotny deleted the codex/docs-historical-whats-new branch July 31, 2026 20:59
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