fix: update sidebar positions for release notes #33208
Conversation
Summary of ChangesHello @tomchon, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the user experience within the documentation by correctly ordering the release notes in the sidebar navigation. By adding specific Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds sidebar_position to several release note files to fix their ordering. The current implementation sorts the release notes chronologically (oldest to newest). For a better user experience, it's generally recommended to sort release notes in reverse chronological order (newest to oldest). I've provided suggestions on the affected files to invert the sidebar_position values to achieve this. The file for version 3.3.6.0 was not commented on as its position 8 is coincidentally correct for either sorting order in this set of 15 files.
| title: TDengine 3.3.2.0 Release Notes | ||
| sidebar_label: 3.3.2.0 | ||
| slug: /release-history/release-notes/3-3-2-0 | ||
| sidebar_position: 1 |
There was a problem hiding this comment.
Release notes are usually sorted with the newest first. To achieve this reverse chronological order, the sidebar_position for this older version should be higher.
| sidebar_position: 1 | |
| sidebar_position: 15 |
| title: TDengine 3.3.3.0 Release Notes | ||
| sidebar_label: 3.3.3.0 | ||
| slug: /release-history/release-notes/3-3-3-0 | ||
| sidebar_position: 2 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 2 | |
| sidebar_position: 14 |
| title: TDengine 3.3.4.3 Release Notes | ||
| sidebar_label: 3.3.4.3 | ||
| slug: /release-history/release-notes/3-3-4-3 | ||
| sidebar_position: 3 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 3 | |
| sidebar_position: 13 |
| sidebar_label: 3.3.4.8 | ||
| description: Version 3.3.4.8 Notes | ||
| slug: /release-history/release-notes/3-3-4-8 | ||
| sidebar_position: 4 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 4 | |
| sidebar_position: 12 |
| sidebar_label: 3.3.5.0 | ||
| description: Version 3.3.5.0 Notes | ||
| slug: /release-history/release-notes/3-3-5-0 | ||
| sidebar_position: 5 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 5 | |
| sidebar_position: 11 |
| sidebar_label: 3.3.6.6 | ||
| description: Version 3.3.6.6 Notes | ||
| slug: /release-history/release-notes/3.3.6.6 | ||
| sidebar_position: 10 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 10 | |
| sidebar_position: 6 |
| sidebar_label: 3.3.6.9 | ||
| description: Version 3.3.6.9 Notes | ||
| slug: /release-history/release-notes/3.3.6.9 | ||
| sidebar_position: 11 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 11 | |
| sidebar_position: 5 |
| sidebar_label: 3.3.7.0 | ||
| description: Version 3.3.7.0 Notes | ||
| slug: /release-history/release-notes/3.3.7.0 | ||
| sidebar_position: 13 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 13 | |
| sidebar_position: 3 |
| sidebar_label: 3.3.7.5 | ||
| description: Version 3.3.7.5 Notes | ||
| slug: /release-history/release-notes/3.3.7.5 | ||
| sidebar_position: 14 |
There was a problem hiding this comment.
To sort release notes in reverse chronological order (newest first), the sidebar_position should be adjusted.
| sidebar_position: 14 | |
| sidebar_position: 2 |
| sidebar_label: 3.3.8.0 | ||
| description: Version 3.3.8.0 Notes | ||
| slug: /release-history/release-notes/3.3.8.0 | ||
| sidebar_position: 15 |
There was a problem hiding this comment.
Release notes are usually sorted with the newest first. To achieve this reverse chronological order, the sidebar_position for this newest version should be the lowest (e.g., 1) to appear at the top.
| sidebar_position: 15 | |
| sidebar_position: 1 |
2 participants
Description
Please briefly describe the code changes in this pull request.
Checklist
Please check the items in the checklist if applicable.