-
-
Notifications
You must be signed in to change notification settings - Fork 53
fix Federation doc link #1257
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?
fix Federation doc link #1257
Conversation
Summary of ChangesHello @xwyqi, 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 resolves an issue where a documentation link within the 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 correctly fixes a broken link in the FEDERATION.md documentation file. I've included one suggestion to improve the phrasing of the sentence containing the link to make it clearer and more descriptive for future readers.
| # Federation | ||
|
|
||
| see [doc](https://neodb.net/internals/federation.md) for FEP-67ff related information. | ||
| see [doc](https://neodb.net/internals/federation) for FEP-67ff related information. |
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 readability, consider rephrasing this sentence. Using a more descriptive link text than doc and structuring the sentence more formally would improve the documentation.
| see [doc](https://neodb.net/internals/federation) for FEP-67ff related information. | |
| For information related to FEP-67ff, see the [federation documentation](https://neodb.net/internals/federation). |
I found that the link returned a 404 page, and then realized that the problem was the extra .md extension in the URL.