-
Notifications
You must be signed in to change notification settings - Fork 58
feat(docs): add version selector dropdown #270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Welcome @zyzzmohit! It looks like this is your first PR to kmesh-net/website 🎉 |
Summary of ChangesHello @zyzzmohit, 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 introduces a significant enhancement to the documentation site by integrating a version selector dropdown into the navigation bar. This feature empowers users to effortlessly switch between different versions of the Kmesh documentation, ensuring they can always access the content relevant to their specific Kmesh installation. The change improves the overall usability and accessibility of the documentation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly adds a version selector dropdown to the documentation navbar using Docusaurus's built-in docsVersionDropdown feature. The implementation is straightforward and follows the desired placement. However, my review identified a critical dependency issue within the project's configuration. The project is configured to use React 19, which is incompatible with Docusaurus v3's requirement for React 18. This mismatch is likely to cause build or runtime errors, and it should be resolved to ensure the website's stability.
| { | ||
| type: "docsVersionDropdown", | ||
| position: "left", | ||
| dropdownActiveClassDisabled: true, | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this change correctly adds the version dropdown, I've identified a critical dependency issue that will likely prevent it from working. The project's package.json specifies React version ^19.0.0, but the Docusaurus version used in this project (@docusaurus/core@3.7.0) has a peer dependency on React ^18.0.0.
This incompatibility will likely cause build failures or runtime errors for the entire site. To fix this, please downgrade react and react-dom in package.json to a version compatible with Docusaurus v3, such as ^18.0.0.
4766ac7 to
cbb7209
Compare
Added docsVersionDropdown navbar item to enable users to select and view documentation for their specific Kmesh version. Changes: - Added version dropdown between Documentation and Blog navbar items - Uses Docusaurus native versioning feature Signed-off-by: zyzzmohit <mohitray949@gmail.com>
cbb7209 to
469a842
Compare
Fixes #147
Added docsVersionDropdown navbar item to enable users to select and view documentation for their specific Kmesh version.
Changes: