-
Notifications
You must be signed in to change notification settings - Fork 70
docs: update relative links path #316
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?
Conversation
Signed-off-by: Guspan Tanadi <[email protected]>
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, you can find updates in the #github-notifications channel in the community Slack. |
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.
Hello @guspan-tanadi, 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!
Summary of Changes
This pull request addresses an issue with relative links in the documentation. Specifically, it updates a link in the Models issue template and corrects the paths to JSON schemas in the index file. The goal is to ensure that the links point to the correct locations, improving navigation and accessibility of the documentation.
Highlights
- Issue Template Link Update: The link to 'Relationships' in the Models issue template has been corrected to point to the proper location.
- JSON Schema Path Correction: The relative paths to the JSON schema files for 'relationships' and 'selectors' in the index file have been updated to ensure they resolve correctly.
Changelog
- .github/ISSUE_TEMPLATE/models.md
- Corrected the link for 'Relationships' to point to the correct documentation page.
- index.md
- Updated the relative paths for 'relationships' and 'selectors' JSON schema links.
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 is currently in preview and 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 to provide feedback.
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.
A link astray,
A path obscured from view,
Docs now align.
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 PR updates relative links in the documentation. The changes seem straightforward and improve the accuracy of the links. However, I have a few observations regarding the changes.
Summary of Findings
- Link Target Verification: Double-check that the content at the new link target in
models.md
is indeed what's intended to be referenced. - Relative Path Correction: Confirm that the new relative paths in
index.md
are correct and that the target files are located in the same directory as theindex.md
file. - Filename Change: Verify that the filename change from
selectors.json
toselector.json
inindex.md
is intentional and correct.
Merge Readiness
The changes in this PR seem to improve the accuracy of the documentation links. However, due to the medium severity concerns raised, I recommend verifying the link targets and relative paths before merging. I am unable to approve this pull request, and users should have others review and approve this code before merging.
Thanks, @guspan-tanadi! @n2h9 would you like to review these proposed changes? |
@n2h9, will you review? |
Notes for Reviewers
This PR fixes #
Signed commits