From 0d76414ce7edc045c1cbcfd788f843b63f08174d Mon Sep 17 00:00:00 2001 From: Parker Lougheed Date: Tue, 18 Nov 2025 12:31:16 -0600 Subject: [PATCH 1/2] Update AI rules by environment table --- src/content/ai/ai-rules.md | 60 +++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/src/content/ai/ai-rules.md b/src/content/ai/ai-rules.md index 270916b2620..92c2b4ca23c 100644 --- a/src/content/ai/ai-rules.md +++ b/src/content/ai/ai-rules.md @@ -1,6 +1,6 @@ --- title: AI rules for Flutter and Dart -description: > +description: >- Learn how to add AI rules to tools that accelerate your development workflow. --- @@ -18,34 +18,46 @@ instructions to an underlying LLM. These files help you: design. * Provide critical project context to the AI. - + Download the Flutter and Dart rules template ## Environments that support rules -Many AI environments support rules files to guide -LLM behavior. Here are some common examples and their -corresponding rule file names: - -| Environment | Rules File | Installation Instructions | -| :--- | :--- |:----------------------------------------------| -| Copilot powered IDEs | `copilot-instructions.md` | [Configure .github/copilot-instructions.md][] | -| Cursor | `AGENTS.md` | [Configure AGENTS.md][] | -| Firebase Studio | `airules.md` | [Configure airules.md][] | -| Gemini CLI | `GEMINI.md` | [Configure GEMINI.md][] | -| JetBrains IDEs | `guidelines.md` | [Configure guidelines.md][] | -| VS Code | `.instructions.md` | [Configure .instructions.md][] | -| Windsurf | `guidelines.md` | [Configure guidelines.md][] | - -[Configure airules.md]: https://firebase.google.com/docs/studio/set-up-gemini#custom-instructions -[Configure .github/copilot-instructions.md]: https://code.visualstudio.com/docs/copilot/copilot-customization#_custom-instructions -[Configure AGENTS.md]: https://cursor.com/docs/context/rules -[Configure guidelines.md]: https://www.jetbrains.com/help/junie/customize-guidelines.html -[Configure .instructions.md]: https://code.visualstudio.com/docs/copilot/copilot-customization#_custom-instructions -[Configure guidelines.md]: https://docs.windsurf.com/windsurf/cascade/memories#rules -[Configure GEMINI.md]: https://codelabs.developers.google.com/gemini-cli-hands-on +Many AI environments support rules files to guide LLM behavior. +Here are some common examples and their corresponding +rule file or directory names: + +| Environment | Rules file or directory | Configuration instructions | +|:---------------------|:----------------------------------|:------------------------------------------------------| +| Copilot-powered IDEs | `.github/copilot-instructions.md` | [Configure instructions for Copilot][copilot] | +| Claude Code | `CLAUDE.md` | [Configure rules for Claude Code][claude] | +| Cursor | `AGENTS.md` | [Configure rules in Cursor][cursor] | +| Firebase Studio | `.idx/airules.md` | [Configure instructions in Firebase Studio][firebase] | +| Gemini CLI | `GEMINI.md` | [Configure context in Gemini CLI][gemini-cli] | +| Google Antigravity | `.agent/rules/.md` | [Configure rules for Antigravity Agent][antigravity] | +| JetBrains IDEs | `.junie/guidelines.md` | [Configure guidelines for Junie][junie] | +| VS Code | `.instructions.md` | [Configure instructions in VS Code][vs-code] | +| Windsurf | `.windsurf/rules/.md` | [Configure rules in Windsurf][windsurf] | + +{:.table .table-striped} + +:::note Support is evolving +Support for rules files is still evolving. +Please check the documentation for your specific development environment for +the most up-to-date naming conventions and instructions. +::: + +[copilot]: https://code.visualstudio.com/docs/copilot/customization/custom-instructions#_use-a-githubcopilotinstructionsmd-file +[claude]: https://www.anthropic.com/engineering/claude-code-best-practices#1-customize-your-setup +[cursor]: https://cursor.com/docs/context/rules +[firebase]: https://firebase.google.com/docs/studio/set-up-gemini#custom-instructions +[gemini-cli]: https://geminicli.com/docs/cli/gemini-md +[antigravity]: https://antigravity.google/docs/rules +[junie]: https://www.jetbrains.com/help/junie/customize-guidelines.html +[vs-code]: https://code.visualstudio.com/docs/copilot/customization/custom-instructions +[windsurf]: https://docs.windsurf.com/windsurf/cascade/memories#rules ## Create rules for your editor @@ -53,7 +65,7 @@ You can adapt our Flutter and Dart rules template for your specific environment. To do so, follow these steps: 1. Download the Flutter and Dart rules template: - rules.md + rules.md 1. In an LLM like [Gemini][], attach the `rules.md` file that you downloaded in From 8594e7e8e408599e95bb92bc31851214230ea514 Mon Sep 17 00:00:00 2001 From: Parker Lougheed Date: Tue, 18 Nov 2025 12:38:06 -0600 Subject: [PATCH 2/2] Remove accidental trailing whitespace --- src/content/ai/ai-rules.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/ai/ai-rules.md b/src/content/ai/ai-rules.md index 92c2b4ca23c..976b97bb645 100644 --- a/src/content/ai/ai-rules.md +++ b/src/content/ai/ai-rules.md @@ -32,11 +32,11 @@ rule file or directory names: | Environment | Rules file or directory | Configuration instructions | |:---------------------|:----------------------------------|:------------------------------------------------------| | Copilot-powered IDEs | `.github/copilot-instructions.md` | [Configure instructions for Copilot][copilot] | -| Claude Code | `CLAUDE.md` | [Configure rules for Claude Code][claude] | +| Claude Code | `CLAUDE.md` | [Configure rules for Claude Code][claude] | | Cursor | `AGENTS.md` | [Configure rules in Cursor][cursor] | | Firebase Studio | `.idx/airules.md` | [Configure instructions in Firebase Studio][firebase] | | Gemini CLI | `GEMINI.md` | [Configure context in Gemini CLI][gemini-cli] | -| Google Antigravity | `.agent/rules/.md` | [Configure rules for Antigravity Agent][antigravity] | +| Google Antigravity | `.agent/rules/.md` | [Configure rules for Antigravity Agent][antigravity] | | JetBrains IDEs | `.junie/guidelines.md` | [Configure guidelines for Junie][junie] | | VS Code | `.instructions.md` | [Configure instructions in VS Code][vs-code] | | Windsurf | `.windsurf/rules/.md` | [Configure rules in Windsurf][windsurf] | @@ -56,7 +56,7 @@ the most up-to-date naming conventions and instructions. [gemini-cli]: https://geminicli.com/docs/cli/gemini-md [antigravity]: https://antigravity.google/docs/rules [junie]: https://www.jetbrains.com/help/junie/customize-guidelines.html -[vs-code]: https://code.visualstudio.com/docs/copilot/customization/custom-instructions +[vs-code]: https://code.visualstudio.com/docs/copilot/customization/custom-instructions#_use-instructionsmd-files [windsurf]: https://docs.windsurf.com/windsurf/cascade/memories#rules ## Create rules for your editor