docs: fix broken markdown links in main README.md

[Hamdanbinhashim]

Summary

Updated link paths of certain links on the main README.md file so that they point to the proper files

Details

Hi team! 👋
I am exploring the codebase as a prospective GSoC 2026 contributor and noticed that several documentation links in the main README.md were broken or leading to wrong folders.

Additional fixes

I also found that architecture.md file does not exist in the docs folder

Related to

Fixes #20288

Changes included:

Updated relative links to point to the correct files:
configuration.md
keyboard-shortcuts.md
tools-api.md
troubleshooting.md
faq.md
commands.md
uninstall.md
tos-privacy.md

Testing:
Verified locally that clicking the links in the Markdown preview now correctly resolves to the respective files in the repository.

How to Validate

1.Open the main README.md file.
2.Click on the links to the above mentioned files.
3.Now it will lead to the correct file locations.

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

[gemini-code-assist]

Summary of Changes

Hello @Hamdanbinhashim, I'm Gemini Code Assist¹! 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 several broken documentation links within the main README.md file. By updating the relative paths for various documentation pages, it ensures that users can correctly navigate to guides for configuration, keyboard shortcuts, commands, tools API, troubleshooting, FAQs, and uninstallation. This significantly enhances the user experience by providing accurate and accessible documentation.

Highlights

• Broken Markdown Links Fixed: Identified and corrected several broken documentation links within the main README.md file.
• Updated Link Paths: Updated relative paths for documentation files such as configuration.md, keyboard-shortcuts.md, commands.md, tools-api.md, troubleshooting.md, faq.md, and uninstall.md to their correct locations.
• Documentation Consistency: Ensured that the README.md now accurately directs users to the relevant documentation sections, improving overall documentation reliability.

Changelog

• README.md
  • Updated the link for "Configuration Guide" from './docs/get-started/configuration.md' to './docs/reference/configuration.md'.
  • Updated the link for "Keyboard Shortcuts" from './docs/cli/keyboard-shortcuts.md' to './docs/reference/keyboard-shortcuts.md'.
  • Updated the link for "Commands Reference" from './docs/cli/commands.md' to './docs/reference/commands.md'.
  • Updated the link for "Tools API Development" from './docs/core/tools-api.md' to './docs/reference/tools-api.md'.
  • Updated the link for "Troubleshooting Guide" from './docs/troubleshooting.md' to './docs/resources/troubleshooting.md'.
  • Updated the link for "FAQ" from './docs/faq.md' to './docs/resources/faq.md'.
  • Updated the link for "Uninstall Guide" from 'docs/cli/uninstall.md' to './docs/resources/uninstall.md'.

Activity

• The author, a prospective GSoC 2026 contributor, identified broken documentation links while exploring the codebase.
• The author verified the fixes locally by clicking the updated links in a Markdown preview.
• The pull request addresses and fixes issue docs: broken documentation links in main README.md #20288.
• The author noted that 'architecture.md' file does not exist in the 'docs' folder, though this is not directly addressed in this PR.

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

[gemini-code-assist]

Code Review

This pull request effectively addresses several broken markdown links in the main README.md file, improving the overall navigation and accessibility of the project's documentation. The changes correctly redirect links to their new locations under docs/reference and docs/resources.

However, it appears that one broken link, specifically to docs/architecture.md, was not addressed, despite being mentioned in the pull request description. Ensuring all known broken links are fixed would further enhance the documentation's quality.

[Hamdanbinhashim]

@SandyTao520 Hi!, I'm prospective GSoC 2026 contributor, this is one of my first PRs. Some of the checks are not getting done. Could you please tell me if there's any problems in the changes i made. Are you a maintainer, could you help me.

[jkcinouye]

LGTM.