-
Notifications
You must be signed in to change notification settings - Fork 99
Docs: Implement three-level expandable dropdown for Plugins submenu under Scheduler #450
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: master
Are you sure you want to change the base?
Docs: Implement three-level expandable dropdown for Plugins submenu under Scheduler #450
Conversation
Signed-off-by: codeEvolveZenith345 <suntiwari3495@gmail.com>
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
|
[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 |
Summary of ChangesHello @codeEvolveZenith345, 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 significantly enhances the documentation structure for the Scheduler's plugins by introducing a more organized and navigable three-level menu system. This change improves user experience by providing dedicated pages for each plugin and a clear hierarchical navigation, overcoming the default limitations of the Hugo static site generator for deeply nested menus. 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 is a great improvement to the documentation structure, implementing a three-level expandable menu for the scheduler plugins. The approach of splitting the plugin documentation into individual files and using a custom Hugo template with JavaScript is well-executed.
My review focuses on improving the new JavaScript implementation for better robustness and maintainability, and also includes several copy-editing suggestions for the new documentation pages to enhance clarity and readability. The key suggestions are:
- Refactoring the JavaScript for toggling and auto-expanding menus in
docs_sidebar.htmlto be more robust and consistent. - Correcting some grammatical errors and improving phrasing in the newly added plugin markdown files.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
Documentation structure enhancement and theme template modification
What this PR does / why we need it:
This PR refactors the Plugins documentation structure to implement a three-level expandable navigation menu, addressing the limitation of Hugo v0.57.2 which doesn't natively support nested submenus.
Changes Made:
Split unified plugins documentation into individual pages:
Implemented three-level menu hierarchy:
Modified theme template (docs_sidebar.html):
.HasChildrencheck)toggleSubmenu()JavaScript function for Plugins dropdowntoggleMenu()function for top-level menu itemsMenu configuration:
parent: "scheduler",identifier: "plugins"parent: "plugins"Technical Implementation:
Since Hugo v0.57.2 doesn't natively support three-level menu nesting, custom template logic was required to:
<ul>elements with proper IDsWhich issue(s) this PR fixes:
Fixes #425
Optimizes #428 accurately.
Verified: