Skip to content

Commit d91b76d

Browse files
docs: add Session Viewer and expand Recording Library documentation
- Document Session Viewer: split-pane layout, step editing, screenshot preview - Add export formats table (Markdown, AI Prompt, GitHub Issue, JSON) - Expand Recording Library with status badges and detailed action descriptions
1 parent 424c3f6 commit d91b76d

1 file changed

Lines changed: 36 additions & 5 deletions

File tree

README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,15 +102,46 @@ Recording_2026-03-15_04-30-00_frames/ # Extracted key frames (PNG)
102102
| `_workflow.json` | AI-generated workflow with titled steps, descriptions, and frame references |
103103
| `_frames/` | Key frames extracted from the video, used as context for AI analysis |
104104

105+
## Session Viewer
106+
107+
After a recording is processed, the **Session Viewer** opens automatically. You can also reopen any past session from the Recording Library.
108+
109+
The viewer is a split-pane interface:
110+
111+
- **Steps Panel** (left) — AI-generated step-by-step workflow with numbered steps, action types, and descriptions
112+
- **Screenshot Preview** (right) — Key frame for the selected step, synced to your selection
113+
- **AI Prompt Tab** — View or copy the raw prompt used for AI analysis
114+
115+
### Editing Steps
116+
117+
Steps are fully editable inside the viewer:
118+
119+
- **Edit** title and description inline
120+
- **Reorder** steps via drag-and-drop
121+
- **Delete** steps you don't need
122+
123+
### Exporting
124+
125+
Click **Export** in the title bar to copy or save the workflow:
126+
127+
| Format | Description |
128+
|--------|-------------|
129+
| **Markdown Steps** | Full document with steps, screenshots, and metadata |
130+
| **AI Agent Prompt** | Ready-to-paste prompt for Cursor, Copilot, Codex, etc. |
131+
| **GitHub Issue** | Issue body with task checklist and context |
132+
| **JSON Workflow** | Machine-readable workflow for automation |
133+
134+
Export to clipboard or save to file — all formats are supported.
135+
105136
## Recording Library
106137

107138
Access all past recordings from the menu bar via **📚 Recording Library**.
108139

109-
- **Browse** — View all recordings with thumbnails, dates, duration, and AI status
110-
- **Open** — Double-click or hit the eye icon to open any session in the Session Viewer
111-
- **Re-process** — Re-run AI analysis with a different provider or updated settings (reuses existing frames)
112-
- **Delete** — Remove a recording and all its associated artifacts (session, workflow, frames)
113-
- **Reveal in Finder** — Jump to the file in Finder
140+
- **Browse** — View all recordings with thumbnails, dates, duration, and status badges (`Steps Generated`, `Unprocessed`, `Processing`, `Failed`)
141+
- **Open** — Double-click or hit the eye icon to load the session in the Session Viewer
142+
- **Re-process** — Re-run AI analysis with a different provider or updated settings (reuses existing frames, skips re-extraction)
143+
- **Delete** — Remove a recording and all its associated artifacts (video, session, workflow, frames) with confirmation
144+
- **Reveal in Finder** — Jump to the recording file in Finder
114145

115146
## Documentation
116147

0 commit comments

Comments
 (0)