Skip to content

Tell agent to write documentations#2655

Merged
ApostaC merged 6 commits intoLMCache:devfrom
KuntaiDu:kuntai-fix-agent
Mar 3, 2026
Merged

Tell agent to write documentations#2655
ApostaC merged 6 commits intoLMCache:devfrom
KuntaiDu:kuntai-fix-agent

Conversation

@KuntaiDu
Copy link
Copy Markdown
Contributor

@KuntaiDu KuntaiDu commented Feb 28, 2026

What this PR does / why we need it:

Long AGENT.md makes it hard for agents to follow. Significantly shorten AGENT.md.

Special notes for your reviewers:

If applicable:

  • this PR contains user facing changes - docs added
  • this PR contains unit tests

@KuntaiDu
edit agents.md to make it shorter
083ceb7 
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
@gemini-code-assist
Copy link
Copy Markdown
Contributor

gemini-code-assist Bot commented Feb 28, 2026

Summary of Changes

Hello, 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 aims to enhance the usability of the AGENTS.md documentation for AI coding agents by drastically reducing its length. The change focuses on streamlining the content to present only the most critical guidelines, making it quicker and easier for agents to process and adhere to the project's requirements.

Highlights

  • Documentation Simplification: The AGENTS.md file has been substantially shortened, removing detailed setup, testing, and convention sections to provide a more concise guide for AI coding agents.

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

Changelog
  • AGENTS.md
    • Removed comprehensive sections covering project overview, Python environment setup, build instructions, detailed testing practices, linting, import ordering, coding conventions, and a full code review checklist.
    • Retained essential guidelines for AI agents, including repository awareness, license header requirements, LMCache specific considerations, code organization principles, documentation standards, testing expectations, and pre-commit checks.
Activity
  • No specific activity (comments, reviews) has been recorded on this pull request yet.
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[bot]
gemini-code-assist Bot reviewed Feb 28, 2026
View reviewed changes
Copy link
Copy Markdown
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 significantly shortens the AGENTS.md file to make it more concise and easier for AI agents to follow. The changes are a good step towards this goal by distilling key guidelines into a simple list. I've added a few suggestions to further improve the readability and clarity of the new content by breaking up long lines and formatting commands into code blocks. These changes should make the guidelines even more effective without significantly increasing the file's length.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
KuntaiDu and others added 4 commits February 27, 2026 16:34
@KuntaiDu @gemini-code-assist
Apply suggestion from @gemini-code-assist[bot]
b08cc72 
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
@KuntaiDu
add documentation requirements
9974cd2 
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
@KuntaiDu
include documentation sphinx requirements
7f972e4 
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
@KuntaiDu
reolsve merge conflict
8c1805a 
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
@KuntaiDu KuntaiDu changed the title Edit agents.md to make it shorter Tell agent to write documentations Feb 28, 2026
ApostaC
ApostaC approved these changes Feb 28, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ApostaC ApostaC left a comment

Choose a reason for hiding this comment

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

LGTM

sammshen
sammshen approved these changes Mar 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@sammshen sammshen left a comment

Choose a reason for hiding this comment

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

LGTM!

@ApostaC ApostaC enabled auto-merge (squash) March 3, 2026 18:25
@github-actions github-actions Bot added the full Run comprehensive tests on this PR label Mar 3, 2026
@ApostaC ApostaC merged commit 4699794 into LMCache:dev Mar 3, 2026
18 checks passed
oferki pushed a commit to oferki/LMCache that referenced this pull request Mar 3, 2026
@KuntaiDu @oferki
Tell agent to write documentations (LMCache#2655)
ca9eea3 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
Signed-off-by: Ofer Kiselov Nahman <ofer.kiselovnahman@weka.io>
oferki pushed a commit to oferki/LMCache that referenced this pull request Mar 3, 2026
@KuntaiDu
Tell agent to write documentations (LMCache#2655)
54a7295 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
hlin99 pushed a commit to hlin99/LMCache that referenced this pull request Mar 4, 2026
@KuntaiDu @hlin99
Tell agent to write documentations (LMCache#2655)
7f71789 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
mauryaavinash95 pushed a commit to mauryaavinash95/LMCache that referenced this pull request Mar 7, 2026
@KuntaiDu
Tell agent to write documentations (LMCache#2655)
c68eb2b 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
shaoxiawjc pushed a commit to shaoxiawjc/LMCache that referenced this pull request Mar 11, 2026
@KuntaiDu @shaoxiawjc
Tell agent to write documentations (LMCache#2655)
7e23ddd 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
Signed-off-by: shaoxiawjc <wjc2800@163.com>
realAaronWu pushed a commit to realAaronWu/LMCache that referenced this pull request Mar 20, 2026
@KuntaiDu
Tell agent to write documentations (LMCache#2655)
634bd82 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
Signed-off-by: Aaron Wu <aaron.wu@dell.com>
jooho-XCENA pushed a commit to xcena-dev/LMCache that referenced this pull request Apr 2, 2026
@KuntaiDu @jooho-XCENA
Tell agent to write documentations (LMCache#2655)
0b22dbc 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
jooho-XCENA pushed a commit to xcena-dev/LMCache that referenced this pull request Apr 2, 2026
@KuntaiDu @jooho-XCENA
Tell agent to write documentations (LMCache#2655)
30d157b 
* edit agents.md to make it shorter

Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: Kuntai Du <kuntai@uchicago.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ApostaC ApostaC ApostaC approved these changes

@sammshen sammshen sammshen approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

full Run comprehensive tests on this PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@KuntaiDu @ApostaC @sammshen