Skip to content

Conversation

@medic-code
Copy link

@medic-code medic-code commented Nov 11, 2025

Summary

This PR fixes broken internal links in the architecture.md documentation file by removing the .md extension.

Details

When rendered on Gemini CLI docs architecture page, links with the .md extension point to the raw Markdown file instead of the rendered HTML page. This change ensures that links in docs/architecture.md correctly navigate to the intended documentation pages.

The following links were updated:

  • /docs/cli/commands.md -> /docs/cli/commands
    • /docs/cli/themes.md -> /docs/cli/themes
  • /docs/get-started/configuration.md -> /docs/get-started/configuration

Related Issues

Fixes #12897

How to Validate

  1. Inspect the docs/architecture.md file and confirm that the .md extensions have been removed from the internal links.
  2. Use a Markdown previewer to check that the links are pointing to the correct relative paths.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@medic-code medic-code requested a review from a team as a code owner November 11, 2025 20:29
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @medic-code, 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 internal links within the 'architecture.md' documentation were incorrectly pointing to raw Markdown files. By removing the '.md' file extension from these links, the PR ensures that users are seamlessly directed to the intended rendered documentation pages, significantly improving the navigation experience and accuracy of the documentation. Additionally, a small formatting detail in a heading was corrected.

Highlights

  • Internal Link Fixes: Removed the '.md' extension from several internal links within 'docs/architecture.md' to ensure they correctly navigate to rendered HTML pages instead of raw Markdown files.
  • Documentation Formatting Correction: Addressed a minor formatting inconsistency in 'docs/architecture.md' by escaping an asterisk in the 'Tools' heading to maintain proper rendering.
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
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 correctly removes the .md extension from several internal links in docs/architecture.md, which will fix how they are rendered on web platforms. The changes align with the goal described in the pull request. However, I found one unrelated change that introduces a formatting error in the same file by incorrectly escaping a Markdown heading. I've added a specific comment with a suggestion to revert this accidental change.

@medic-code
Copy link
Author

/gemini review

Copy link
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 correctly removes the .md extension from internal links in docs/architecture.md, which will fix navigation in the rendered documentation. The changes are accurate and address the described issue. I have reviewed the changes and they look good. As a suggestion for a follow-up, it might be beneficial to check for and fix similar links in other documentation files to ensure consistency across the entire documentation site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Link Fix: Remove .md Extensions from Internal Links in architecture.md

1 participant