Docs: sentence-case headings and cleaner release nav

[kingthorin]

• Standardize docs and release note headings to sentence case
• Group older releases under collapsible 2.x and 1.x sections in the sidebar
• Replace fragile awk scripts in the release workflow with small Java helpers (with tests)

Note

I did setup mkdocs and test the site changes locally.

[what-the-diff]

PR Summary

• Updated Version Update Workflow

  • The process of generating release notes has been automated with a Java class called ReleaseNotesGenerator, aiming to reduce manual efforts and potential errors.
  • The navigation of version details in our documentation is now updated using MkdocsReleaseNavUpdater Java class, enhancing user experience by making it easier to browse through different versions.

• Documentation Changes

  • The term "YAML" has been standardized in our documentation providing a consistent reading experience.
  • Section titles have been made more consistent - "What's Changed" is now always written as "What's changed" for congruity.

• Release Templates Adjustments

  • The structure of release templates in our documentation has been revised, aiming to provide a more structured and easy-to-follow format.

• Enhanced Release Notes

  • Release notes from versions 1.6.0 to 2.5.0 now include a more detailed list of contributors and changes. This will improve recognition of individual contributions and aid in understanding what has changed.

• Revised Release Notes' Format

  • The writing style in our release notes has been updated, replacing "What's Changed" and "New Contributors" to the more consistent "What's changed" and "New contributors" format across multiple markdown files.

• Release Notes Addition

  • New release notes have been added for versions 2.5.1 to 2.6.0, each detailing respective updates and contributions.

• Improved Structure of Release Navigation

  • The navigation of releases has been restructured in mkdocs.yml to provide a clearer hierarchy of "2.x" and "1.x" versions.

• Automated Release Navigation Updates

  • A new Java class MkdocsReleaseNavUpdater has been implemented which automatically updates the mkdocs.yml navigation when a new release is made, removing the need for manual updates.

• Quality Assurance with Unit Tests

  • Introduced unit tests for the MkdocsReleaseNavUpdater and ReleaseNotesGenerator classes to validate their functionality, ensuring our automated processes are working as expected.

• Automated Release Notes Generation

  • A new class ReleaseNotesGenerator creates release note files automatically based on templates and input data, removing the need for manual creation and thus promoting efficiency.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.49%. Comparing base (f805ad9) to head (7a15af0).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1843      +/-   ##
============================================
+ Coverage     92.45%   92.49%   +0.04%     
- Complexity     3519     3521       +2     
============================================
  Files           344      344              
  Lines          6969     6969              
  Branches        684      684              
============================================
+ Hits           6443     6446       +3     
+ Misses          360      359       -1     
+ Partials        166      164       -2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[kingthorin]

Thank you!!