Skip to content

Commit c45f1c0

Browse files
authored
update to best practice docs (#1586)
1 parent 90bb060 commit c45f1c0

File tree

1 file changed

+44
-28
lines changed

1 file changed

+44
-28
lines changed

docs/ai_builder/overview/best_practices.md

Lines changed: 44 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Once generated, copy each prompt into the AI Builder to execute them in sequence
3333
**Example workflow:**
3434

3535
1. Switch to Chat Mode and paste your full app specification
36-
2. Ask: *"Break this into a series of buildable prompts I can feed into the Agent Mode."*
36+
2. Ask **"Break this into a series of buildable prompts I can feed into the Agent Mode."**
3737
3. Copy each generated prompt into Agent Mode one by one
3838
4. Build iteratively using the structured prompts
3939

@@ -43,20 +43,22 @@ If you have a structured app specification, don't paste the entire document into
4343

4444
**Pro tip:** Use **Chat Mode** to help prepare prompts:
4545

46-
- Paste your full app spec and ask: *"Break this into buildable prompts I can feed into the builder."*
47-
- Or ask: *"Write one prompt per feature/page to build this app."*
46+
Paste your full app spec and ask:
47+
48+
- **"Break this into buildable prompts I can feed into the builder."**
49+
- **"Write one prompt per feature/page to build this app."**
4850

4951
This hybrid approach — planning in **Chat Mode**, then building in **Agent Mode** — lets you move faster and build smarter.
5052

5153
### Writing Clear, Task-Oriented Prompts
5254

5355
The AI performs best when it receives **specific, outcome-driven instructions**. Avoid vague, broad prompts.
5456

55-
**Bad:**
56-
> "Build me an admin dashboard."
5757

58-
**Good:**
59-
> "Create a 2-column layout with a sidebar for navigation and a top navbar."
58+
```diff
59+
- Build me an admin dashboard. # <- Bad
60+
+ Create a 2-column layout with a sidebar for navigation and a top navbar. # <- Good
61+
```
6062

6163
Whenever possible, split large tasks into smaller steps:
6264

@@ -66,9 +68,13 @@ Whenever possible, split large tasks into smaller steps:
6668
- Use follow-ups to style and polish
6769

6870
Use precise styling language, for example:
69-
> "Add medium spacing between grid items and use large rounded corners on cards"
7071

71-
Avoid subjective terms like "nice," "modern," or "clean." Treat your prompt as interface documentation for the builder.
72+
```diff
73+
- Grid items have small spacing and sharp corners.
74+
+ Add medium spacing between grid items and use large rounded corners on cards.
75+
```
76+
77+
Avoid subjective terms like "**nice**," "**modern**," or "**clean**." Treat your prompt as interface documentation for the builder.
7278

7379
### Working with Images and Visual References
7480

@@ -82,9 +88,12 @@ You can drop in screenshots of websites, dashboards, apps, or even hand-drawn wi
8288

8389
**Get UI/UX feedback using Chat Mode:**
8490

85-
- Upload a screenshot and ask: *"What are 5 things I could do to improve the UI/UX of this?"*
86-
- Follow up with: *"Implement items 1, 2, and 4 in the builder."*
87-
- Or request specific improvements: *"Make this more minimal and mobile-first."*
91+
Upload a screenshot and ask: **"What are 5 things I could do to improve the UI/UX of this?"**
92+
93+
94+
Follow up with: **Implement items 1, 2, and 4 in the builder.**
95+
96+
Or request specific improvements: **Make this more minimal and mobile-first.**
8897

8998
---
9099

@@ -101,50 +110,57 @@ Trying to generate your full app in a single prompt almost never works well. Ins
101110

102111
At each stage, give feedback and iterate. If the AI builder makes something close, you can say:
103112

104-
> "Reuse this structure but remove the modal and make the sidebar collapsible."
113+
```diff
114+
- Modal is included and sidebar is static.
115+
+ Remove modal and make sidebar collapsible.
116+
117+
- Buttons vary across pages.
118+
+ Use same button style from home page.
105119

106-
**Reuse and reference earlier outputs:**
120+
- Card layout differs across sections.
121+
+ Repeat card layout from dashboard section.
122+
```
107123

108-
- *"Use the same button style from the home page here."*
109-
- *"Repeat the card layout from the dashboard section."*
110-
- *"Match the data table structure from the 'Users' tab."*
111124

112125
### Improving UI/UX
113126

114127
To improve your design, ask the builder for more polished layouts, better structure, or more modern styles.
115128

116-
**Examples:**
129+
```diff
130+
- Layout feels cluttered with small headings and dense sections.
131+
+ Increase heading sizes and spacing between sections for better hierarchy.
117132

118-
- *"Make this more minimal."*
119-
- *"Improve visual hierarchy."*
120-
- *"This page feels dense. Add more spacing and reduce visual clutter."*
121-
- *"Make this more mobile-first."*
133+
- Navigation buttons are inconsistent.
134+
+ Standardize button sizes and colors for consistent UX.
135+
```
122136

123137
**Suggested workflow:**
124138

125139
1. In Chat Mode, upload an image or describe the layout.
126-
2. Ask: *"Tell me 5 things that would improve the UI/UX of this page."*
140+
2. Ask: **"Tell me 5 things that would improve the UI/UX of this page."**
127141
3. Review the suggestions and decide which ones you want to apply.
128-
4. Switch to Agent Mode and implement: *"Improve visual hierarchy by increasing heading sizes and adding more spacing between sections."*
142+
4. Switch to Agent Mode and implement: **"Improve visual hierarchy by increasing heading sizes and adding more spacing between sections."**
129143

130144
### Using Knowledge to Guide the Build
131145

132146
The **Knowledge** panel lets you provide long-form references that influence how the agent builds your app. Add design systems, style guides, brand guidelines, or architecture rules.
133147

134148
Once added, the builder will try to honor these rules throughout the session, ensuring consistency without repeating instructions.
135149

136-
**Try combining Knowledge with Chat Mode:**
150+
Try combining Knowledge with Chat Mode:
151+
152+
- **Use the style guide in Knowledge to improve this page.**
153+
154+
- **Is the current layout aligned with our design system in Knowledge?**
137155

138-
- *"Use the style guide in Knowledge to improve this page."*
139-
- *"Is the current layout aligned with our design system in Knowledge?"*
140156

141157
### Local Development Integration
142158

143159
We have an MCP server available for enterprise customers to connect local AI development tools such as Claude Desktop, Windsurf, or Codex.
144160

145161
This enables a hybrid workflow: generate your app and make major changes in the App Builder, then move to local development for detailed refinements and custom functionality.
146162

147-
> **🏢 Enterprise Feature:** The Reflex MCP integration is currently only available for enterprise customers. [Book a demo](https://reflex.dev/pricing/) to discuss access.
163+
> **Enterprise Feature:** The Reflex MCP integration is currently only available for enterprise customers. [Book a demo](https://reflex.dev/pricing/) to discuss access.
148164
149165
#### Quick Setup
150166

0 commit comments

Comments
 (0)