Skip to content

Conversation

@koverholt
Copy link
Collaborator

Based on the updated approach to llms.txt in ADK docs in google/adk-docs#1023, this PR:

  • Updates vibe coding section to use new llms.txt approach, and link to new "Coding with AI" guide in ADK docs, with steps for Gemini CLI and Antigravity
  • Updates links in README to auto-generated llms.txt and llms-full.txt in the ADK docs site
  • Removes manually generated llms.txt and llms-full.txt in this repo, since these are now autogenerated in ADK docs
  • Various fixes / formatting updates in README

Checklist

  • I have read the CONTRIBUTING.md document.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have manually tested my changes end-to-end.
  • Any dependent changes have been merged and published in downstream modules.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @koverholt, 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 primarily updates the project's README.md to align with recent changes in the ADK documentation ecosystem. It modifies how AI-assisted coding context files (llms.txt and llms-full.txt) are referenced, moving from local copies to external, auto-generated versions. Additionally, it introduces a new guide for 'Coding with AI' and includes various textual and formatting improvements to the README.

Highlights

  • Updated llms.txt approach: The README now reflects the new approach for llms.txt and llms-full.txt, which are now auto-generated and hosted in the ADK documentation repository.
  • New 'Coding with AI' guide: A new section on 'Vibe Coding' has been added to the README, linking to a dedicated 'Coding with AI' guide in the ADK docs, which provides instructions for using these files with tools like Gemini CLI and Antigravity.
  • Removed local llms.txt files: The manually generated llms.txt and llms-full.txt files have been removed from this repository, as they are now sourced from the ADK documentation site.
  • README formatting and grammar fixes: Several minor fixes and formatting updates have been applied throughout the README to improve readability and accuracy.
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.

@adk-bot adk-bot added the documentation [Component] This issue is related to documentation, it will be transferred to adk-docs label Dec 5, 2025
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 updates the README.md to reflect the new approach for llms.txt files, which are now auto-generated and hosted in the ADK docs. The local llms.txt and llms-full.txt files have been removed accordingly. The changes also include several wording and formatting improvements in the README. The updates are clear and improve the documentation. I have one minor suggestion to improve the phrasing in the 'Contributing' section for better readability.

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

Labels

documentation [Component] This issue is related to documentation, it will be transferred to adk-docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants