Scaffold initial agent guidelines file for repository

[parlough]

Adds a rudimentary AGENTS.md file to the root of the repository which provides coding agents with background information and core guidelines it should always have in its context when working on the repository. This helps agents immediately understand what the project is, what CLI tools they should use, and what guidelines it should always follow.

This PR only adds some basic content to provide an initial structure. The guidelines can be incrementally replaced, expanded, and improved by the team in future PRs. While doing so though, do note it's best to keep only most impactful, universally applicable context in this file. Other guidelines are best left to conditionally applied rules or skills.

Some suggested follow up:

• Instead of linking to the developer documentation style guide, outline the most impactful writing guidelines that you often see agents messing up when working on our site.
• Instead of linking to Effective Dart, just reference it and outline the most impactful or unique coding guidelines for working on the site.

[gemini-code-assist]

Summary of Changes

Hello, 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 establishes a foundational document, AGENTS.md, intended to guide AI agents interacting with the Flutter documentation website's codebase and content. By providing a clear overview of the project, its structure, essential commands, and style guidelines, this file aims to enhance the efficiency and consistency of AI-driven development and content creation from the outset.

Highlights

• Initial Agent Guidelines File: Added a new file, AGENTS.md, to the repository root. This file is designed to provide essential project context and core guidelines specifically for AI coding and writing agents working on the Flutter documentation repository.
• Agent Guidance Content: The AGENTS.md file includes sections on project overview, directory structure, common CLI commands, and specific content and coding guidelines (e.g., Google developer documentation style guide, semantic line breaks, Effective Dart).

🧠 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
  • Added a new file AGENTS.md to provide guidance for AI agents working on the repository.

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]

Code Review

This pull request introduces the initial AGENTS.md file, providing essential project context and guidelines for agentic coding and writing tools. The file clearly outlines the project overview, directory structure, common commands, and initial content and coding guidelines. This is a great starting point for ensuring agents have the necessary information to contribute effectively.

_{Note: Security Review has been skipped due to the limited scope of the PR.}

I am having trouble creating individual review comments. Click here to see my feedback.

AGENTS.md (62-63)

The pull request description suggests outlining the most impactful writing guidelines directly in this file, rather than just linking to the Google developer documentation style guide. This would provide more immediate and curated value for agents, making the AGENTS.md file more self-contained and actionable.

AGENTS.md (74-75)

Similar to the writing style, the pull request description recommends outlining the most impactful or unique coding guidelines for working on the site, instead of solely referencing Effective Dart. Providing these specific guidelines here would enhance the utility of this document for agents.

[flutter-website-bot]

Visit the preview URL for this PR (updated for commit 805560b):

https://flutter-docs-prod--pr13152-misc-rudimentary-agents-md-lspm9vub.web.app