-
Notifications
You must be signed in to change notification settings - Fork 13
chore/add versioned documentation with auto detection in docs v48 #1279
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
chore/add versioned documentation with auto detection in docs v48 #1279
Conversation
Summary of ChangesHello @Killusions, 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 comprehensive system for managing and serving versioned documentation. It includes a backend script to merge and sort documentation version metadata, ensuring all available versions are correctly represented. Additionally, a frontend script automatically redirects users to the latest documentation version, improving navigation and ensuring consistent access to up-to-date content. Highlights
Ignored Files
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 introduces versioning for the documentation by adding two new scripts and updating the mkdocs.yml configuration. A Node.js script (merge-versions.mjs) is added to merge and sort documentation versions, and a client-side JavaScript file (version-redirect.js) handles redirection to the correct versioned path.
The changes are well-implemented. The redirect script is robust, and the merge script correctly handles different version formats and edge cases. I've provided a couple of suggestions for the merge-versions.mjs script and one for version-redirect.js to improve code maintainability and readability by reducing duplication and simplifying complex conditions. Overall, this is a solid contribution.
88ac6b3 to
271749a
Compare
a7fd116 to
03555ac
Compare
|
Tested and works, closing |
5b79581 to
5309317
Compare
5309317 to
138daec
Compare
|
Documentation. Coverage Reports: |
6edc2fd to
bf8da97
Compare
|
Seems to still work, closing |
bf8da97 to
ac9696d
Compare
ac9696d to
97de94a
Compare
|
Works, closing again |
Only for testing #752