document360-engine 0.2.10 → 0.2.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "document360-engine",
3
- "version": "0.2.10",
3
+ "version": "0.2.11",
4
4
  "description": "Headless documentation agent engine for document360-writer / -desktop. Emits a typed event stream; no UI.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/skills/CLAUDE.md CHANGED
@@ -112,6 +112,7 @@ The "Capabilities" section below lists specialized skills. Pick the right one ba
112
112
  - Any "convert/wrap this into a callout/tabs/FAQ/accordion" request, or authoring with rich components → apply `d360-markdown` (always-on syntax reference).
113
113
  - "/publish ..." → `publish-to-d360`.
114
114
  - "/screenshot ..." or any time you generate a screenshot placeholder → also call `emit-screenshot-spec`.
115
+ - "/capture-setup" / "what data do I need for screenshots" / after authoring screenshot specs in bulk → `capture-setup-checklist`.
115
116
  - Pulling extra context from other MCP sources during write-article → `gather-context-from-mcp`.
116
117
 
117
118
  If the user's intent is ambiguous, ask before invoking a skill that writes files or publishes.
@@ -0,0 +1,43 @@
1
+ # Skill: capture-setup-checklist
2
+
3
+ **Activate when** the user asks how to prepare data for screenshots ("what data do I need for captures", "capture setup", `/capture-setup`), OR right after you've emitted screenshot specs in bulk.
4
+
5
+ **Goal:** one reviewable "stage this data" checklist, so the user dresses the demo context ONCE before running `d360-capture` — the way a technical writer prepares a demo account before a screenshot session. Screenshots can't show data that isn't there; this tells the user exactly what to create.
6
+
7
+ ## How
8
+
9
+ 1. **Collect.** Find every `<!-- SCREENSHOT ... -->` block across `<docsDir>/**/*.md`. From each, read the `id`, the title, and the `prerequisites:` lines.
10
+ 2. **Anchor to the scope.** Read the capture `scope` keys from `.d360-capture.json` (e.g. `project`, or `project`+`workspace`, or `org` — whatever THIS product scopes by; do not assume "project"). If no scope is set yet, recommend the keys you saw the product use and tell the user to set them.
11
+ 3. **Synthesize — don't dump.** A raw per-spec list is noise. Instead:
12
+ - **Group by context** (e.g. "In the demo project «`scope.project`»:").
13
+ - **Dedupe** overlapping needs — if eight shots each need "≥1 suite", say it once.
14
+ - **Order foundational → specific**: create the context first, then the records, then per-shot specifics.
15
+ - **Separate the un-stageable**: shots needing a transient state (a toast, a mid-import modal) go under "Set up by hand at capture time", not the standing-data list.
16
+ 4. **Write it** to `<captureDir>/CAPTURE-SETUP.md` (versioned + reviewable). Re-running refreshes it.
17
+ 5. **Close** by telling the user the path, to set `scope` in `.d360-capture.json` to point at the prepared context, then `d360-capture auth` (once) and `d360-capture capture`.
18
+
19
+ ## Quality bar
20
+
21
+ - **Concrete:** real record names and counts ("create a suite named *Smoke*", "import one API spec"), not "have some data".
22
+ - **Generic:** use the product's actual scope keys; never hardcode FlowForge's "project".
23
+ - **Honest:** if a spec's `prerequisites:` are missing or vague, list that spec under "Needs a clearer prerequisite" rather than inventing data. Don't pretend a checklist item exists when the source doesn't say so.
24
+
25
+ ## Shape of the output (illustrative)
26
+
27
+ ```markdown
28
+ # Capture data setup
29
+
30
+ Prepare this once, then run `d360-capture capture`.
31
+
32
+ ## In the demo project "Docs Demo"
33
+ - [ ] At least 1 **suite** (e.g. "Smoke") — needed by: suites-tab-list, suite-run-dashboard, …
34
+ - [ ] At least 3 **schedules** — needed by: schedules-list-populated, schedule-context-menu
35
+ - [ ] 1 **capture** with a click-gallery + a video — needed by: captures-detail-*
36
+ - [ ] 1 imported **API spec** (with a version folder) — needed by: spec-import-*
37
+
38
+ ## Set up by hand at capture time (transient states)
39
+ - flow-generation-timeout-banner — trigger a generation timeout, then capture.
40
+
41
+ ## Needs a clearer prerequisite
42
+ - <spec-id> — its SCREENSHOT block doesn't say what data it needs; refine it.
43
+ ```
@@ -101,6 +101,7 @@ Don't write a fragile selector. Instead:
101
101
 
102
102
  - Report the spec's path.
103
103
  - List anything that needs the user: the `data-testid`s a dev must add (TODO hatch), and the **data prerequisites** to stage (project/workspace + the records each shot needs).
104
+ - After authoring several specs, run `capture-setup-checklist` to refresh the consolidated `CAPTURE-SETUP.md` staging guide.
104
105
  - Remind how to capture (screenshots are a separate tool — not bundled with the writer):
105
106
  1. First time only: `npm i -g document360-capture`
106
107
  2. Set the capture `scope` for the prepared demo context in `.d360-capture.json`.