-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Fix broken links in llms.txt according to issue #4158 #4163
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
Conversation
Summary of ChangesHello @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 Highlights
🧠 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 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 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.
| - [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) |
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.
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.
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.
I understand that llms.txt is auto-generated. I will update the source documentation files so the broken links are fixed permanently.
Fix broken links in llms.txt (Issue #4158)
Link to Issue or Description of Change
#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:
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