Skip to content

Conversation

@Tahira-2
Copy link

Fix broken links in llms.txt (Issue #4158)

Link to Issue or Description of Change

#4158

  • Closes: #_issue_number_4158
  • Related: #_issue_number_4158

Problem:
Several links in llms.txt were broken due to documentation reorganization or removed files. This made it difficult for users to navigate to the correct ADK documentation pages.

Solution:
Updated llms.txt so all links point to existing, relevant documentation, and removed links that no longer have replacements:

⦁ Replaced [Using Different Models with ADK] with the new models index page:
https://github.com/google/adk-docs/blob/main/docs/agents/models/index.md

⦁ Replaced [Deploy to Vertex AI Agent Engine] with the new agent-engine index page (original page was split to multiples pages):

https://github.com/google/adk-docs/blob/main/docs/deploy/agent-engine/index.md
⦁ Replaced [Testing your Agents] with the update page (page was renamed from 'get-started/testing.md' to 'runtime/api-server.md'):
https://github.com/google/adk-docs/blob/main/docs/runtime/api-server.md

⦁ Removed [Custom Audio Streaming app (WebSocket)] and [Custom Audio Streaming app (SSE)] links
the original pages were removed and reorganized into multiple files, no direct replacements exist.

⦁ Replaced [Authenticating with Tools] with the updated page (the page was moved 'tools' to 'tools-custom'):
https://github.com/google/adk-docs/blob/main/docs/tools-custom/authentication.md

⦁ Replaced [Built-in tools] with the new tools index page (original page was split to multiples pages):
https://github.com/google/adk-docs/blob/main/docs/tools/index.md

⦁ Replaced [Function Tools] with the updated page (the page was moved from 'function tools' to 'tools-custom'):
https://github.com/google/adk-docs/blob/main/docs/tools-custom/function-tools.md

⦁ Replaced [Google Cloud Tools] with the updated page (page was moved from 'tools' to 'tools/google-cloud'):
https://github.com/google/adk-docs/blob/main/docs/tools/google-cloud/application-integration.md

⦁ Replaced [Model Context Protocol Tools] with updated page (page moved from 'tools' to 'tools-custom'):
https://github.com/google/adk-docs/blob/main/docs/tools-custom/mcp-tools.md

⦁ Removed [OpenAPI Integration]:
issue mentioned: (page moved from 'tools' to 'tools/third-party/openapi-tools.md')
No such file found.

⦁ Replaced [Third Party tools] with updated page (page moved from 'tools' to 'tools/third-party'):
https://github.com/google/adk-docs/blob/main/docs/tools/third-party/index.md

This ensures that all links in llms.txt now point to live, correct documentation, improving usability for developers.

Testing Plan

Since these are documentation changes, no unit or E2E tests are required. Verification was performed manually:

Manual Verification:

  • Opened the updated llms.txt in VS Code
  • Clicked each link to confirm it navigates to the correct, existing documentation page
  • Confirmed that removed links do not point to non-existent pages

Please describe the tests that you ran to verify your changes. This is required
for all PRs that are not small documentation or typo fixes.

Checklist

  • I have read the CONTRIBUTING.md document.
  • I have performed a self-review of my changes.
  • I have updated documentation links as needed.
  • All links in llms.txt now point to existing, relevant documentation.
  • No unit tests are needed for this documentation-only change.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Tahira-2, 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 and resolves multiple broken links within the llms.txt file. The primary goal is to ensure that all documentation references are current and functional, thereby improving the overall user experience and navigability of the ADK documentation. This prevents users from encountering dead ends when seeking information about various ADK features like models, deployment, testing, and tools.

Highlights

  • Documentation Link Updates: Several links within llms.txt have been updated to reflect recent documentation reorganization, ensuring they point to the correct and existing pages.
  • Removed Obsolete Links: Two links related to "Custom Audio Streaming app" and one for "OpenAPI Integration" have been removed as their original pages no longer exist and direct replacements were not found.
  • Improved Navigation: These changes collectively enhance the usability of the ADK documentation by resolving broken links and providing accurate navigation paths for users.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 addresses broken documentation links in llms.txt. While the updated links appear correct, the fundamental issue is that llms.txt is an auto-generated file. The changes made directly to this file are not persistent and will be lost when the generation script (contributing/dev/utils/build_llms_txt.py) is run again. The correct approach is to address the root cause, which is likely outdated source documentation files or logic in the generation script that doesn't account for the reorganization in the adk-docs repository. I've left a critical comment explaining that the changes should be made to the source of truth, not the generated output.

Comment on lines 213 to -225
- [ADK Bidi-streaming development guide: Part 1 - Introduction](https://github.com/google/adk-docs/blob/main/docs/streaming/dev-guide/part1.md)
- [Bidi-streaming(live) in ADK](https://github.com/google/adk-docs/blob/main/docs/streaming/index.md)
- [Streaming Tools](https://github.com/google/adk-docs/blob/main/docs/streaming/streaming-tools.md)
- [Authenticating with Tools](https://github.com/google/adk-docs/blob/main/docs/tools/authentication.md)
- [Built-in tools](https://github.com/google/adk-docs/blob/main/docs/tools/built-in-tools.md)
- [Function tools](https://github.com/google/adk-docs/blob/main/docs/tools/function-tools.md)
- [Google Cloud Tools](https://github.com/google/adk-docs/blob/main/docs/tools/google-cloud-tools.md)
- [Authenticating with Tools](https://github.com/google/adk-docs/blob/main/docs/tools-custom/authentication.md)
- [Built-in tools](https://github.com/google/adk-docs/blob/main/docs/tools/index.md)
- [Function tools](https://github.com/google/adk-docs/blob/main/docs/tools-custom/function-tools.md)
- [Google Cloud Tools](https://github.com/google/adk-docs/blob/main/docs/tools/google-cloud/application-integration.md)
- [Tools](https://github.com/google/adk-docs/blob/main/docs/tools/index.md)
- [Model Context Protocol Tools](https://github.com/google/adk-docs/blob/main/docs/tools/mcp-tools.md)
- [OpenAPI Integration](https://github.com/google/adk-docs/blob/main/docs/tools/openapi-tools.md)
- [Third Party Tools](https://github.com/google/adk-docs/blob/main/docs/tools/third-party-tools.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This file, llms.txt, is automatically generated by the contributing/dev/utils/build_llms_txt.py script. The manual changes to fix broken links in this PR will be overwritten the next time the generation script is run.

To properly fix these broken links, the source documentation files that the script processes need to be updated, or the generation script itself needs to be modified to account for the new documentation structure in the adk-docs repository. Please apply the fixes to the source instead of the generated output file.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand that llms.txt is auto-generated. I will update the source documentation files so the broken links are fixed permanently.

@Tahira-2 Tahira-2 closed this Jan 15, 2026
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.

1 participant