Skip to content

Commit b374524

Browse files
committed
docs: align entity and UX docs with merged PRD model
1 parent f8b07f0 commit b374524

4 files changed

Lines changed: 66 additions & 0 deletions

File tree

docs/entities.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,34 @@ enum StreamEventType {
185185
}
186186
```
187187

188+
## PRD Terminology Mapping
189+
190+
| PRD term | Canonical entity model |
191+
|---|---|
192+
| Task | UnitTask |
193+
| Session | AgentSession (scoped by SubTask) |
194+
| PR Creation step | SubTask (`type = PR_CREATE`) |
195+
| Review/CI remediation step | SubTask (`type = PR_REVIEW_FIX` or `PR_CI_FIX`) |
196+
197+
## PRD Task State Mapping (Derived UI Labels)
198+
199+
PRD task labels are presentation-oriented states.
200+
Persisted source of truth remains `UnitTaskStatus`, `SubTaskStatus`, and `AgentSessionStatus`.
201+
202+
| PRD label | Derived mapping in canonical model |
203+
|---|---|
204+
| Draft | client-side draft before UnitTask is created |
205+
| Queued | `UnitTaskStatus = QUEUED` and initial `SubTaskStatus = QUEUED` |
206+
| Running | `UnitTaskStatus = IN_PROGRESS` with active `SubTaskStatus = IN_PROGRESS` |
207+
| WaitingForHuman | `UnitTaskStatus = ACTION_REQUIRED` with `SubTaskStatus = WAITING_FOR_USER_INPUT` or `WAITING_FOR_PLAN_APPROVAL` |
208+
| PlanReady | `UnitTaskStatus = ACTION_REQUIRED` with `SubTaskStatus = WAITING_FOR_PLAN_APPROVAL` |
209+
| Approved | derived UI checkpoint after plan approval; persisted execution continues as `UnitTaskStatus = IN_PROGRESS` |
210+
| Building | derived UI checkpoint while build-phase SubTask is `IN_PROGRESS` |
211+
| PRCreating | derived UI checkpoint while `SubTaskType = PR_CREATE` and `SubTaskStatus = IN_PROGRESS` |
212+
| Completed | `UnitTaskStatus = COMPLETED` |
213+
| Failed | `UnitTaskStatus = FAILED` or active SubTask/session failed |
214+
| Canceled | `UnitTaskStatus = CANCELLED` or `SubTaskStatus = CANCELLED` |
215+
188216
## Core Entities
189217

190218
### Workspace

docs/notifications.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ DexDex uses Web Notification API as the primary desktop and mobile notification
1515
3. PR review activity requires remediation
1616
4. PR CI failure
1717
5. AgentSession failure
18+
6. Agent session requires human input (`WAITING_FOR_USER_INPUT`)
19+
7. Authentication/session refresh required for continued workflow
20+
21+
Trigger mapping note:
22+
23+
1. trigger semantics use existing notification enums in `docs/entities.md`
24+
2. auth-required prompts are represented through action-required notification categories
1825

1926
## Notification Flow
2027

docs/ui.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Desktop layout:
2727
3. Center pane: task and PR list with filters
2828
4. Right pane: details, timeline, and actions
2929

30+
Focused three-pane variant for detail-heavy workflows:
31+
32+
1. left: task list and workspace switcher
33+
2. center: active task detail and timeline
34+
3. right: collapsed history, side activity, and auxiliary context
35+
3036
Mobile layout:
3137

3238
1. top segmented tabs (Tasks, PRs, Review Assist, Notifications)
@@ -103,6 +109,9 @@ Sections:
103109
3. PR Attention queue
104110
4. Completed recently
105111

112+
Completed work is retained, not deleted.
113+
The default behavior is collapsed history that users can expand on demand.
114+
106115
Each card includes:
107116

108117
1. title
@@ -135,6 +144,22 @@ Contains:
135144
9. stop controls for in-progress UnitTask and SubTask
136145
10. inline comment threads anchored to diff lines
137146

147+
## Task Creation UX
148+
149+
Task creation uses a modal flow with keyboard-first submit.
150+
151+
Required inputs:
152+
153+
1. Repository Group
154+
2. Task Prompt
155+
156+
Optional and policy-driven inputs:
157+
158+
1. execution mode selector (local or remote, workspace policy dependent)
159+
2. coding agent selection
160+
3. plan-mode preference when supported by selected agent
161+
4. suggested task title
162+
138163
### Stop Controls
139164

140165
Users can stop running work with minimal friction:

docs/workspace-connectivity.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,9 @@ Both types use the same:
4545

4646
Mobile clients use the same workspace concept.
4747
A mobile app can connect to local endpoints (same network or tunneled) and remote endpoints.
48+
49+
Capability rollout is phased:
50+
51+
1. baseline mobile flow focuses on remote monitoring, logs, plan actions, and stop actions
52+
2. expanded mobile flow adds broader remediation and review interactions
53+
3. connectivity contract stays identical across desktop and mobile

0 commit comments

Comments
 (0)