-
Notifications
You must be signed in to change notification settings - Fork 13
chore/add versioned documentation with auto detection in docs main #1280
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 main #1280
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 displaying versioned documentation. It includes a backend script to consolidate version metadata, a frontend script to ensure users are directed to the most current documentation by default, and updates to the MkDocs configuration to enable these features. The primary goal is to enhance the discoverability and organization of different documentation versions. 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 a script to merge version files, a client-side script for redirection, and updating the mkdocs.yml configuration. The changes are well-structured. I've provided a few suggestions to improve code clarity and reduce duplication in the new scripts for better long-term maintainability.
|
Documentation. Coverage Reports: |
37488f2 to
364b865
Compare
|
@spliffone This is not the right PR but I also fixed them on #752 |
364b865 to
9783345
Compare
|
Tested and works, closing |
9783345 to
f441fec
Compare
|
Works again, closing |
Only for testing #752