Skip to content

Make site-specific links work in docs on both the site and GitHub#21437

Closed
diodesign wants to merge 5 commits intomainfrom
docs-harmonize-site-gh-links
Closed

Make site-specific links work in docs on both the site and GitHub#21437
diodesign wants to merge 5 commits intomainfrom
docs-harmonize-site-gh-links

Conversation

@diodesign
Copy link
Copy Markdown
Contributor

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

  • [ X ] Updated relevant documentation

@diodesign diodesign requested review from a team as code owners March 6, 2026 19:10
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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

  • Link Consistency: Updated relative links to the "Plans page" in documentation files to absolute URLs (https://geminicli.com/plans/) to ensure they function correctly on both the Gemini CLI website and GitHub.
Changelog
  • docs/get-started/authentication.md
    • Updated the "Plans page" link to an absolute URL.
  • docs/get-started/gemini-3.md
    • Updated the "Plans page" link to an absolute URL.
  • docs/resources/quota-and-pricing.md
    • Updated the "Plans page" link to an absolute URL.
Activity
  • No activity to report yet.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 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.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 6, 2026

Size Change: -4 B (0%)

Total Size: 26.1 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 25.7 MB -4 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 221 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 227 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 11.5 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B

compressed-size-action

@gemini-cli gemini-cli bot added priority/p1 Important and should be addressed in the near term. area/documentation Gemini CLI documentation tasks and issues area/site Gemini CLI website (https://geminicli.com) labels Mar 6, 2026
@g-samroberts
Copy link
Copy Markdown
Contributor

Wierd, I see the changes are gone. Maybe fixed in another PR?

@diodesign
Copy link
Copy Markdown
Contributor Author

Wierd, I see the changes are gone. Maybe fixed in another PR?

Yeah, it was merged in with #21490

@diodesign diodesign closed this Mar 20, 2026
@diodesign diodesign deleted the docs-harmonize-site-gh-links branch March 20, 2026 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Gemini CLI documentation tasks and issues area/site Gemini CLI website (https://geminicli.com) priority/p1 Important and should be addressed in the near term.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix-up links in docs for consistent behavior on GitHub and website

2 participants