-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[FIXED] Update links in README for project resources to avoid 404 #1623
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
Conversation
Right now, all the links resolves to 404 due to extra `../` removing project name from the path. * Before: `https://github.com/android/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65` * After: `https://github.com/android/compose-samples/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65` * Before: `https://github.com/android/tree/v2024.05.00/Jetsurvey` * After: `https://github.com/android/compose-samples/tree/v2024.05.00/Jetsurvey`
Summary of ChangesHello @hossain-khan, 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 addresses an issue where several resource links in the README.md file were broken, leading to 404 errors. By adjusting the relative paths, the changes ensure that all listed project and commit links are now functional, significantly improving the accuracy and navigability of the project's documentation. 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 broken links in the README.md file by adjusting the relative path depth. While the fix is correct, I've suggested an improvement to use absolute URLs for these links. This will make them more robust and work correctly regardless of the context in which the README is rendered, and it also aligns with the style of other links in the document.
| | [Crane](../../tree/v2024.05.00/Crane) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | ||
| | [Owl](../../tree/v2024.05.00/Owl) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | ||
| | [Jetsurvey](../../tree/v2024.05.00/Jetsurvey) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | ||
| | [Rally](../../tree/v2024.05.00/Rally) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | |
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.
While the relative links you've added are correct, it's a good practice to use absolute links for resources within a repository's documentation. This ensures that the links remain valid even if the content is viewed outside of the GitHub web UI (e.g., in a local editor or a different rendering tool).
Using absolute URLs would also make these links consistent with others in this file, like those under the 'High level features' section.
| | [Crane](../../tree/v2024.05.00/Crane) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Owl](../../tree/v2024.05.00/Owl) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Jetsurvey](../../tree/v2024.05.00/Jetsurvey) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Rally](../../tree/v2024.05.00/Rally) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Crane](https://github.com/android/compose-samples/tree/v2024.05.00/Crane) | 2024-08-02 | [ee8e272](https://github.com/android/compose-samples/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Owl](https://github.com/android/compose-samples/tree/v2024.05.00/Owl) | 2024-08-02 | [ee8e272](https://github.com/android/compose-samples/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Jetsurvey](https://github.com/android/compose-samples/tree/v2024.05.00/Jetsurvey) | 2024-08-02 | [ee8e272](https://github.com/android/compose-samples/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | | |
| | [Rally](https://github.com/android/compose-samples/tree/v2024.05.00/Rally) | 2024-08-02 | [ee8e272](https://github.com/android/compose-samples/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) | |
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.
There must have been reasons to use relative path! 🤔
Right now, all the links resolves to 404 due to extra
../removing project name from the path.https://github.com/android/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65https://github.com/android/compose-samples/commit/ee8e27289f4bc36304ee9f04397f49c35f402a65https://github.com/android/tree/v2024.05.00/Jetsurveyhttps://github.com/android/compose-samples/tree/v2024.05.00/Jetsurvey