You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/userGuide.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ No account or installation required. Everything runs in the browser. Your work i
14
14
- Click "Generate" to produce AI build instructions
15
15
16
16
> [!TIP]
17
-
> For the best experience use Chrome or Edge. The auto-save feature (File System Access API) requires a Chromium-based browser. Firefox and Safari work but without auto-save.
17
+
> For the best experience use Chrome or Edge. The auto-save feature requires a Chromium-based browser. Firefox and Safari work but without auto-save.
18
18
19
19
## Uploading Screens
20
20
@@ -36,9 +36,9 @@ You can replace the image on an existing screen by pasting from the clipboard or
36
36
37
37
For pixel-perfect results, use `Shift+Cmd+C` (Copy as PNG) in Figma, then paste into Drawd with `Cmd/Ctrl+V`. Drawd automatically detects the Figma frame name and applies it to the screen.
38
38
39
-
If you use regular `Cmd+C` in Figma, Drawd renders a layout preview using the clipboard scene graph. Text, shapes, gradients, vectors, and shared library components are rendered at their correct positions, while raster images (photos, backgrounds) appear as transparent areas since the clipboard does not include image pixel data. A loading overlay is shown during rendering.
39
+
If you use regular `Cmd+C` in Figma, Drawd renders a layout preview. Text, shapes, gradients, vectors, and shared library components appear at their correct positions, while photos and background images show as transparent areas since regular copy does not include image data. A loading overlay is shown during rendering.
40
40
41
-
After the layout preview is added, a tip appears suggesting `Shift+Cmd+C` for pixel-perfect results. If you follow the tip and paste within 30 seconds, the frame name and Figma metadata are automatically applied to the new paste.
41
+
After the layout preview is added, a tip appears suggesting `Shift+Cmd+C` for pixel-perfect results. If you follow the tip and paste within 30 seconds, the frame name is automatically applied to the new paste.
42
42
43
43
> [!TIP]
44
44
> For best results, copy one frame at a time. Use `Shift+Cmd+C` in Figma (not regular `Cmd+C`) to get a pixel-perfect image with all raster content included.
@@ -136,7 +136,7 @@ Hold `Shift` and click multiple hotspots on the same screen to select them. Use
136
136
137
137
## Connecting Screens
138
138
139
-
Connections (navigation links) show how a user moves from one screen to another. They appear as bezier arrows on the canvas between screen cards.
139
+
Connections (navigation links) show how a user moves from one screen to another. They appear as curved arrows on the canvas between screen cards.
140
140
141
141
### Creating a connection via hotspot
142
142
@@ -197,7 +197,7 @@ Each state has a name field visible in the sidebar (e.g., "Loading", "Error", "E
197
197
State groups are reflected in the AI build instructions. Each variant screen is listed with its state name, and the instruction generator notes which screens share a group.
198
198
199
199
> [!NOTE]
200
-
> Deleting the only remaining variant in a state group automatically removes the group metadata, returning that screen to standalone status.
200
+
> Deleting the only remaining variant in a state group automatically removes the group, returning that screen to standalone status.
201
201
202
202
## Sticky Notes
203
203
@@ -279,7 +279,7 @@ When you generate AI instructions, all data models are compiled into a `types.md
279
279
280
280
## API Connections
281
281
282
-
The API action type on hotspots models asynchronous network calls — tapping a button triggers an API endpoint, with separate navigation paths for success and error responses.
282
+
The API action type on hotspots models network requests — tapping a button triggers an API endpoint, with separate navigation paths for success and error responses.
283
283
284
284
### Configuring an API hotspot
285
285
@@ -325,7 +325,7 @@ If any documents are referenced by hotspots, a `documents.md` file is included i
325
325
326
326
## File Operations
327
327
328
-
Drawd saves projects as `.drawd` files — a JSON format containing all screens, connections, hotspots, and documents.
328
+
Drawd saves projects as `.drawd` files containing all screens, connections, hotspots, and documents.
329
329
330
330
### Auto-save (Chromium only)
331
331
@@ -350,7 +350,7 @@ You can drag a `.drawd` file directly onto the canvas. If the canvas is empty, t
350
350
351
351
### Import vs. Open
352
352
353
-
Open replaces the current canvas entirely. Import merges the incoming screens and connections into the current project, remapping IDs to avoid collisions and offsetting positions to avoid overlap.
353
+
Open replaces the current canvas entirely. Import merges the incoming screens and connections into the current project, automatically adjusting positions to avoid overlap.
354
354
355
355
> [!TIP]
356
356
> Export to .drawd before sharing with collaborators. They can open the file in any browser (auto-save requires Chromium, but manual export/import works everywhere).
@@ -435,11 +435,7 @@ Press `?` anywhere on the canvas to open the full keyboard shortcuts panel. The
435
435
436
436
## Collaboration
437
437
438
-
Drawd supports real-time collaboration so multiple people can view and edit the same flow simultaneously. The feature uses Supabase Realtime for message relay and presence tracking — no additional server setup required.
439
-
440
-
### Requirements
441
-
442
-
Collaboration requires a Supabase project. Add `VITE_SUPABASE_URL` and `VITE_SUPABASE_ANON_KEY` to a `.env` file in the project root. See `.env.example` for the format. If these values are not configured, the Share button will show a configuration prompt.
438
+
Drawd supports real-time collaboration so multiple people can view and edit the same flow simultaneously.
443
439
444
440
### Creating a room
445
441
@@ -451,7 +447,7 @@ Collaboration requires a Supabase project. Add `VITE_SUPABASE_URL` and `VITE_SUP
451
447
452
448
### Joining a room
453
449
454
-
- Click Share and switch to the "Join" tab, or navigate directly to `https://drawd.app/#/editor?room=CODE`
450
+
- Click Share and switch to the "Join" tab, or use the direct join link shared by the host
455
451
- Enter a display name, choose a color, and type the 6-character room code
456
452
- Click "Join Room"
457
453
- The host's current flow will load automatically
@@ -492,9 +488,9 @@ If the host leaves or closes their browser, all guests see a "Session Ended" mod
492
488
493
489
### Known limitations
494
490
495
-
- Guest undo is not available — applying remote state clears the undo history.
496
-
- Very large flows with many high-resolution screen images may hit the Supabase broadcast payload limit (~1 MB). Consider using lower-resolution screenshots for collaboration.
497
-
-State sync uses last-write-wins with a 500ms debounce. Rapid changes may appear slightly delayed on guest screens.
491
+
- Guest undo is not available while connected to a room.
492
+
- Very large flows with many high-resolution screen images may cause sync issues. Consider using lower-resolution screenshots for collaboration.
493
+
-Rapid changes by multiple editors may appear slightly delayed on other screens.
0 commit comments