[docs, misc] chore: finalize AGENTS guidelines and ignore local planning files

[Wangmerlyn]

Summary by CodeRabbit

• Chores
  • Updated project ignore rules to exclude specific intermediate documentation artifacts.
• Documentation
  • Added a comprehensive developer guidelines document covering workflow, planning, testing, branching, quality, and release practices.

[gemini-code-assist]

Summary of Changes

Hello @Wangmerlyn, 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 introduces a foundational document outlining best practices and operational guidelines for coding agents, ensuring consistency and quality across development efforts. Concurrently, it refines the repository's .gitignore configuration to prevent the accidental inclusion of temporary planning and progress files, contributing to a cleaner version control history.

Highlights

• New Agent Guidelines Document: A new AGENTS.md file has been added, providing comprehensive guidelines for coding agents operating within the repository. This document covers general reusable practices (language, workflow, planning, code review, documentation, quality, Git hygiene) and project-specific rules for KeepGPU (product surface, architecture, platform dependencies, testing, documentation, and release hygiene).
• Gitignore Update: The .gitignore file has been updated to include new entries for local planning files such as task_plan.md, findings.md, and progress.md, preventing them from being committed to the repository.

🧠 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

• .gitignore
  • Added /task_plan.md to ignored files
  • Added /findings.md to ignored files
  • Added /progress.md to ignored files
• AGENTS.md
  • Added new file AGENTS.md
  • Defined general guidelines for agents including language, workflow, planning, code review, documentation, quality bar, and Git hygiene
  • Established project-specific guidelines for KeepGPU covering product interfaces, architecture boundaries, platform/dependency rules, testing expectations, documentation, and release hygiene

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds three mkdocs-related ignore entries to .gitignore and introduces a new AGENTS.md document with comprehensive guidelines for coding agents and project development practices.

Changes

Cohort / File(s)	Summary
Configuration Updates \.gitignore	Added three ignore patterns for mkdocs-generated/temporary documentation files: task_plan.md, findings.md, progress.md.
Development Documentation AGENTS.md	New guidelines file (≈100 lines) detailing agent workflows, planning, code review, documentation standards, testing/CI expectations, git hygiene, and project-specific conventions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit scampers, pen in paw, 🐇
Notes and rules without a flaw,
.gitignore tucked neat and slim,
AGENTS.md sings the dev hymn,
Hops of progress, soft and prim. ✨

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: adding comprehensive AGENTS guidelines and ignoring local planning files in .gitignore.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/agents-md

---

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments

AGENTS.md (1)

46-47: Consider clarifying the commit vs PR format difference.

The commit message format uses type(scope): summary with parentheses, while the PR title format uses [modules] type: description with square brackets. This difference might be intentional (commits target single scopes; PRs may span multiple modules), but the distinction isn't explained. Consider adding a brief note explaining why the formats differ, or aligning them if consistency is preferred.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request introduces a comprehensive AGENTS.md file with guidelines for automated agents and updates the .gitignore to exclude local planning files. The guidelines are well-structured and clear, providing valuable direction for development in this repository. I've added one comment to address a potentially outdated file path in the testing documentation to ensure its accuracy.

[gemini-code-assist]

The test file path tests/test_cli_thresholds.py appears to be outdated, as this file is not present in the repository. Please remove this path from the command or update it to point to the correct test file for CLI thresholds to ensure the documentation is accurate.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@AGENTS.md`:
- Around line 33-36: The root-docs rule is ambiguous because AGENTS.md is a
project-specific file in the repo root; update the wording in AGENTS.md (the
bullet about "Do NOT place project-specific documentation in the root
directory") to either add an explicit exception for existing top-level files
like AGENTS.md/README or rephrase to “Avoid placing new project-specific
documentation in the root; keep only canonical top-level docs (e.g., AGENTS.md,
README) in root.” This change should be applied in the same AGENTS.md paragraph
so reviewers clearly understand the exception without altering other rules.