Skip to content

Commit f645629

Browse files
committed
Addres review comments
1 parent ddfe445 commit f645629

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

docs/workspace/agent-panel.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The AI automatically has access to:
5656
- The widget you currently have selected
5757
- Recent changes you've made
5858
- Your project's dependencies and configuration
59-
- Your project-level guideline files (.cursorrules, CLAUDE.md, AGENTS.md, or ARCHITECTURE.md) to keep generated code consistent.
59+
- Your project-level guideline files to keep generated code consistent.
6060

6161

6262
### Image Attachments
@@ -231,28 +231,18 @@ Without project rules, you repeat long instructions in every prompt, for example
231231
Add a login screen and use the BLoC pattern for state management, follow Clean Architecture, and place new features under /features/...
232232
```
233233

234-
With project rules, you can define these standards once in a file such as [`AGENTS.md`](http://AGENTS.md) and then simply ask:
234+
With project rules, you can define these standards once and then simply ask:
235235

236236
```
237237
Add a login screen.
238238
```
239239

240-
#### Supported Rule Files
241-
242-
Dreamflow scans for the following rule files in your project, in this priority order:
243-
244-
| Priority | Filename | Typical Purpose |
245-
| --- | --- | --- |
246-
| 1️⃣ | **.cursorrules** | Originally designed for the Cursor IDE but supported in Dreamflow for compatibility with existing codebases. |
247-
| 2️⃣ | [**CLAUDE.md**](https://code.claude.com/docs/en/overview) | Anthropic-style AI instruction file that can include guidelines for tone, safety, or project-specific context. |
248-
| 3️⃣ | [**AGENTS.md**](https://agents.md/) | Defines how AI agents should behave in your project, including coding standards, architecture patterns, and testing rules. |
249-
| 4️⃣ | [**ARCHITECTURE.md**](https://architecture.md/) | Documents your project’s structure, data flow, and design philosophy for better context. |
250240

251241
:::info
252-
Dreamflow loads only the first matching file based on priority. For example, if `.cursorrules` exists, Dreamflow will ignore `CLAUDE.md`, `AGENTS.md`, and `ARCHITECTURE.md`.
242+
Dreamflow supports common rule file formats such as [**`CLAUDE.md`**](https://code.claude.com/docs/en/overview), **`.cursorrules`**, and [**`ARCHITECTURE.md`**](https://architecture.md/), but it is **recommended to use the [`AGENTS.md`](https://agents.md/) file**.
253243
:::
254244

255-
When any of the supported rule files is loaded into the Agent’s context:
245+
When the rule file is loaded into the Agent’s context:
256246

257247
- The file’s contents are **appended to the system prompt** and used to fine-tune how the Agent generates, edits, and structures code.
258248
- These rules are applied to **every Agent action**, ensuring consistent behavior across your entire project.
@@ -264,7 +254,7 @@ Follow these steps to add project rules:
264254

265255
**Step 1: Create Rule File**
266256

267-
Create one of the supported rule files with the help of ChatGPT or Claude. While creating the file, include your project’s coding standards, architecture pattern, folder structure, testing requirements, and security guidelines.
257+
Create rule files with the help of ChatGPT or Claude. While creating the file, include your project’s coding standards, architecture pattern, folder structure, testing requirements, and security guidelines.
268258

269259
Here’s a sample prompt you can use to generate your `AGENTS.md` file:
270260

@@ -312,7 +302,7 @@ features/[feature]/presentation/
312302

313303
You can add project rules at **two levels**:
314304

315-
**1. Root-level Rule File:** Place a global rule file (e.g., `AGENTS.md`, `.cursorrules`, `CLAUDE.md`, or `ARCHITECTURE.md`) in the **project root**, beside `pubspec.yaml`.
305+
**1. Root-level Rule File:** Place a rule file in the **project root**, beside `pubspec.yaml`.
316306

317307
- This file has **global scope**.
318308
- It is **always loaded** before every Agent action, no matter which part of the project you're working in.

0 commit comments

Comments
 (0)