-
Notifications
You must be signed in to change notification settings - Fork 26
add introductory video link to the Hot Topics section #332
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
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.
Summary of Changes
Hello @tae898, 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 enhances the project's documentation by integrating an introductory video link directly into a highly visible section. The change aims to provide a more accessible and engaging entry point for users to understand ArcadeDB, complementing the existing text-based resources.
Highlights
- Documentation Update: A direct link to an introductory video for ArcadeDB has been added to the prominent "Hot Topics" section, making it easier for new users to quickly grasp the basics.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
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 .gemini/
folder in the base of the repository. Detailed instructions can be found here.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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 link to an introductory video in the 'Hot Topics' section. The change is functionally correct. I have provided one suggestion to improve the long-term maintainability of this documentation file by using an AsciiDoc attribute for the video ID.
@@ -2,6 +2,7 @@ | |||
|
|||
Skip the boring parts and check this out: | |||
|
|||
* https://youtu.be/Gz9sc6LkFT4[Watch "An Introduction to ArcadeDB"] |
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.
For better maintainability, consider defining the YouTube video ID as an AsciiDoc attribute at the top of the document and then referencing it here. This makes it easier to update the link in the future if the video changes, as the value is centralized in one place.
For example, you could add this at the beginning of the file:
:intro-video-id: Gz9sc6LkFT4
And then change this line to:
* https://youtu.be/{intro-video-id}[Watch "An Introduction to ArcadeDB"]
I am not in favor of adding this video link, especially not to the most prominent position in the docs. IMHO anybody arriving at the docs needs specific info about ArcadeDB and not an ad. I also have some quality issues with the video itself (if you want I can send those to you privately). |
No description provided.