Skip to content

docs: update AGENTS.md with improved structure#7160

Merged
chenjiahan merged 2 commits intomainfrom
agents_md_0208
Feb 8, 2026
Merged

docs: update AGENTS.md with improved structure#7160
chenjiahan merged 2 commits intomainfrom
agents_md_0208

Conversation

@chenjiahan
Copy link
Member

Summary

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings February 8, 2026 01:27
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @chenjiahan, 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 clarity and usability of the AGENTS.md documentation. By reorganizing the content into distinct, well-defined sections and providing more detailed explanations, the changes significantly improve the onboarding experience for new contributors and offer a quick reference for existing team members regarding the project's technical stack, operational commands, and architectural layout.

Highlights

  • Documentation Structure: The AGENTS.md file has been significantly reorganized to follow a more logical and clear structure, making it easier to navigate and understand project details.
  • New Sections Introduced: New dedicated sections for 'Stack', 'Commands', and 'Project structure' have been added, providing specific information on each topic.
  • Detailed Project Overview: A detailed overview of the project's monorepo structure is now included, clarifying the purpose of different directories like packages/core/, e2e/, and website/.
  • Updated Command Examples: The 'Commands' section now features clearer, grouped examples for setup, development checks, and focused work, presented within a bash code block.
Changelog
  • AGENTS.md
    • Content reorganized into new top-level sections: 'Stack', 'Commands', 'Project structure', and 'Code style'.
    • Added a 'Stack' section detailing Node.js version, monorepo tools (pnpm, Nx), TypeScript usage, and test runner.
    • Replaced the old 'Setup' and 'Commands' sections with a new 'Commands' section, including bash code blocks for setup, dev checks, and focused work commands.
    • Introduced a 'Project structure' section with a text code block illustrating the monorepo directory layout.
    • Updated the 'Code style' section with refined guidelines for formatting, TypeScript strictness, and naming conventions.
    • Removed the initial descriptive paragraph about the monorepo's purpose.
Activity
  • The pull request was created by chenjiahan with the intent to update AGENTS.md for improved structure, following a recent GitHub status update.
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 refactors the AGENTS.md file to have a more structured and concise format, which is better for consumption by AI agents. The changes are well-organized into sections for stack, commands, project structure, and code style. My review includes one suggestion to restore the package naming convention (kebab-case) to the code style section for completeness.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR restructures AGENTS.md to better guide contributors/agents by organizing the repository’s development environment, common commands, project layout, and code style into clearer sections.

Changes:

  • Replaced the previous “Setup/Commands/Architecture” layout with “Stack / Commands / Project structure / Code style”.
  • Added an explicit command block for setup, dev checks, and focused package/test workflows.
  • Added a simplified directory tree overview of the monorepo.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 8, 2026 01:32
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chenjiahan chenjiahan merged commit 6a87bb4 into main Feb 8, 2026
10 of 11 checks passed
@chenjiahan chenjiahan deleted the agents_md_0208 branch February 8, 2026 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant