-
Notifications
You must be signed in to change notification settings - Fork 3.4k
docs: add Engine glossary entry #12780
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
Summary of ChangesHello @sfshaza2, 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 new glossary entry for 'Engine' to enrich the documentation. Concurrently, it refines the behavior of expandable cards across the site, specifically for glossary entries. The changes ensure that all glossary cards are initially collapsed by default, while also providing functionality to automatically expand a specific card if its ID is present in the URL fragment, thereby improving user navigation and overall experience. 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
|
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 adds a new glossary entry for 'Engine' and refactors the expandable card behavior to support direct linking to glossary terms. The changes are well-implemented across the Dart components and YAML data file. The new logic for handling expandable cards is a good improvement, making them collapsed by default and expanding them via JavaScript only when they are targeted in the URL fragment.
I have a couple of suggestions for improvement:
- In
site/lib/src/pages/glossary.dart, there's a minor accessibility issue with the initial state of thearia-expandedattribute for the expand/collapse button. - In
src/data/glossary.yml, I've suggested adding a link to the 'Impeller' glossary term from the new 'Engine' entry to improve navigation.
|
Visit the preview URL for this PR (updated for commit 66031db): |
|
Thanks for your excellent feedback, @loic-sharma! Please check again. |
loic-sharma
left a comment
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.
Looks good!
|
@parlough, Loic has approved. Can you give it a gander? |
parlough
left a comment
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.
Looks good to me. Thanks :D
| 5. Responsible for asset resolution. | ||
| [framework]: /resources/architectural-overview#architectural-layers | ||
| [Impeller]: /resources/glossary/#impeller |
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.
| [Impeller]: /resources/glossary/#impeller | |
| [Impeller]: /resources/glossary#impeller |
Fixes #12641. Adds a glossary entry for 'Engine' to src/data/glossary.yml.