Make site-specific links work in docs on both the site and GitHub#21437
Make site-specific links work in docs on both the site and GitHub#21437
Conversation
Summary of ChangesHello, 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 relative links within the documentation, specifically those pointing to the "Plans page," were broken when viewed on GitHub. By converting these links to absolute URLs, the changes ensure a consistent and functional user experience, allowing users to access the "Plans page" regardless of whether they are viewing the documentation on the official website or directly on GitHub. Highlights
Changelog
Activity
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.
Code Review
This pull request updates documentation links to ensure they function correctly on both the project website and GitHub. The change replaces a relative link to the 'Plans' page with an absolute URL across three markdown files. This resolves an issue where the links were broken when accessed from the GitHub repository. The changes are correct and well-contained. No issues were found during the review.
Note: Security Review has been skipped due to the limited scope of the PR.
|
Size Change: -4 B (0%) Total Size: 26.1 MB ℹ️ View Unchanged
|
|
Wierd, I see the changes are gone. Maybe fixed in another PR? |
Yeah, it was merged in with #21490 |
Summary
Clicking on the Plans page links in the docs on GitHub 404, as that section doesn't exist in this repository, tho they work on the website, which hosts that particular content. The Plans links should be absolute so they work whether you're looking at the docs on the .com or GitHub.
Details
We want to achieve parity in user experience on both the Gemini CLI website and the GitHub repository. Doc links should work in either situation.
Related Issues
Fixes #21435
How to Validate
Links to the Plans page should work on both the website and GitHub.
Pre-Merge Checklist