Skip to content

Commit 13b8ab3

Browse files
committed
docs: remove technical jargon from user guide
Simplify language in user-facing documentation by replacing implementation details with plain, audience-appropriate terms.
1 parent 8d09ee8 commit 13b8ab3

1 file changed

Lines changed: 13 additions & 17 deletions

File tree

src/pages/docs/userGuide.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ No account or installation required. Everything runs in the browser. Your work i
1414
- Click "Generate" to produce AI build instructions
1515

1616
> [!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.
1818
1919
## Uploading Screens
2020

@@ -36,9 +36,9 @@ You can replace the image on an existing screen by pasting from the clipboard or
3636

3737
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.
3838

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.
4040

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.
4242

4343
> [!TIP]
4444
> 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
136136
137137
## Connecting Screens
138138

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.
140140

141141
### Creating a connection via hotspot
142142

@@ -197,7 +197,7 @@ Each state has a name field visible in the sidebar (e.g., "Loading", "Error", "E
197197
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.
198198

199199
> [!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.
201201
202202
## Sticky Notes
203203

@@ -279,7 +279,7 @@ When you generate AI instructions, all data models are compiled into a `types.md
279279
280280
## API Connections
281281

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.
283283

284284
### Configuring an API hotspot
285285

@@ -325,7 +325,7 @@ If any documents are referenced by hotspots, a `documents.md` file is included i
325325
326326
## File Operations
327327

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.
329329

330330
### Auto-save (Chromium only)
331331

@@ -350,7 +350,7 @@ You can drag a `.drawd` file directly onto the canvas. If the canvas is empty, t
350350

351351
### Import vs. Open
352352

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.
354354

355355
> [!TIP]
356356
> 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
435435
436436
## Collaboration
437437

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.
443439

444440
### Creating a room
445441

@@ -451,7 +447,7 @@ Collaboration requires a Supabase project. Add `VITE_SUPABASE_URL` and `VITE_SUP
451447

452448
### Joining a room
453449

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
455451
- Enter a display name, choose a color, and type the 6-character room code
456452
- Click "Join Room"
457453
- 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
492488

493489
### Known limitations
494490

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.
498494

499495
## MCP Server (AI Agent Integration)
500496

0 commit comments

Comments
 (0)