Conversation
…to make-doc-links-relative
…consistently on GitHub and the website. Fix up CONTRIBUTING.md for now so links always work wherever.
|
Hi @diodesign, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this. We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines. Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed. Thank you for your understanding and for being a part of our community! |
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 significantly enhances the reliability and consistency of documentation links throughout the Gemini CLI project. By standardizing link formats, it addresses issues where links might break or render incorrectly depending on the viewing environment, ultimately providing a more robust and seamless experience for users accessing the documentation. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request systematically updates links across the documentation to improve their reliability on both GitHub and the project's website. The changes involve converting root-relative links to either path-relative links for intra-documentation navigation or absolute URLs for external pages and top-level site pages. The use of reference-style links has also been refactored to use inline links, which improves maintainability. The changes are consistent and well-executed, aligning with the goal of providing a seamless experience for readers.
Note: Security Review has been skipped due to the limited scope of the PR.
gemini-cli
bot
added
the
status/need-issue
|
Size Change: -4 B (0%) Total Size: 26 MB ℹ️ View Unchanged
|
…to make-doc-links-relative
diodesign
changed the title
…emini/gemini-cli into make-doc-links-relative Removing docs/ide-integration/ide-companion-spec.md as there are no link-related changes to it.
diodesign
force-pushed
the
make-doc-links-relative
branch
from
ccfe427 to
239c624
Compare
| [`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder | ||
| [`read_file`]: /docs/tools/file-system.md#2-read_file-readfile | ||
| [`grep_search`]: /docs/tools/file-system.md#5-grep_search-searchtext | ||
| [`write_file`]: /docs/tools/file-system.md#3-write_file-writefile | ||
| [`glob`]: /docs/tools/file-system.md#4-glob-findfiles | ||
| [`google_web_search`]: /docs/tools/web-search.md | ||
| [`replace`]: /docs/tools/file-system.md#6-replace-edit | ||
| [MCP tools]: /docs/tools/mcp-server.md | ||
| [`save_memory`]: /docs/tools/memory.md | ||
| [`activate_skill`]: /docs/cli/skills.md | ||
| [`codebase_investigator`]: /docs/core/subagents.md#codebase-investigator | ||
| [`cli_help`]: /docs/core/subagents.md#cli-help-agent | ||
| [subagents]: /docs/core/subagents.md | ||
| [custom subagents]: /docs/core/subagents.md#creating-custom-subagents | ||
| [policy engine]: /docs/reference/policy-engine.md | ||
| [`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode | ||
| [`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode | ||
| [`ask_user`]: /docs/tools/ask-user.md | ||
| [YOLO mode]: /docs/reference/configuration.md#command-line-arguments |
There was a problem hiding this comment.
are reference style links not handled well by the website? if so, should we remove all of them for consistency? I prefer reference style links because it makes the docs cleaner and it's easier to reuse links across the doc
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
3 participants
Summary
Links in our documentation to other pages in our docs need to be relative due to the way they are handled by the Gemini CLI's website framework and GitHub.
Details
We should provide as consistent a user experience as possible for readers of the website and GitHub. Links should not 404, and should render as expected by the visitor. This PR fixes up several pages with relative links, moves away from using unsupported reference-style links, and ensures for now that the contributing page has working links regardless of where it is read.
Related Issues
Fixes maintainers-gemini-cli#1503
How to Validate
Check that links on GitHub do not 404, and links on the website do not 404 nor render unexpectedly as markdown.
Pre-Merge Checklist