-
Notifications
You must be signed in to change notification settings - Fork 9.2k
docs: Remove .md extension from internal links in architecture.md #12899
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
base: main
Are you sure you want to change the base?
docs: Remove .md extension from internal links in architecture.md #12899
Conversation
Summary of ChangesHello @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
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 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.
|
/gemini review |
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 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.
Summary
This PR fixes broken internal links in the
architecture.mddocumentation file by removing the.mdextension.Details
When rendered on Gemini CLI docs architecture page, links with the
.mdextension point to the raw Markdown file instead of the rendered HTML page. This change ensures that links indocs/architecture.mdcorrectly 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/configurationRelated Issues
Fixes #12897
How to Validate
docs/architecture.mdfile and confirm that the.mdextensions have been removed from the internal links.Pre-Merge Checklist