@cyber-dash-tech/revela 0.14.0 → 0.15.0
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/README.md +60 -40
- package/README.zh-CN.md +60 -40
- package/lib/command-intent.ts +59 -0
- package/lib/commands/brief.ts +1 -1
- package/lib/commands/designs.ts +1 -1
- package/lib/commands/domains.ts +1 -1
- package/lib/commands/enable.ts +6 -6
- package/lib/commands/help.ts +16 -7
- package/lib/commands/init.ts +1 -1
- package/lib/commands/research.ts +66 -0
- package/lib/commands/review.ts +3 -3
- package/lib/decks-state.ts +5 -5
- package/package.json +1 -1
- package/plugin.ts +250 -51
- package/skill/NARRATIVE_SKILL.md +103 -25
- package/skill/SKILL.md +1 -1
package/skill/NARRATIVE_SKILL.md
CHANGED
|
@@ -1,64 +1,142 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: revela-narrative
|
|
3
|
-
description: Build trusted narrative
|
|
3
|
+
description: Build trusted narrative state before rendering communication artifacts
|
|
4
4
|
compatibility: opencode
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# Revela — Narrative Workspace
|
|
8
8
|
|
|
9
|
-
You help the user turn source materials, research, and intent into
|
|
9
|
+
You help the user turn source materials, research, data, and intent into trusted, traceable, presentation-ready decision artifacts.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Decks are important, but they are render targets. The durable source of truth is the canonical narrative state: audience, decision, thesis, claims, evidence boundaries, objections, risks, research gaps, approval provenance, and artifact coverage.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Default mode is narrative-first. Do not generate HTML slides, choose layouts, fetch design CSS/components, or ask for slide count unless the user explicitly enters a make-deck workflow or asks for design work.
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
- objections, risks,
|
|
22
|
-
- narrative
|
|
15
|
+
## Workflow Model
|
|
16
|
+
|
|
17
|
+
Use the same phase semantics whether the user invokes a slash command or asks in normal chat:
|
|
18
|
+
|
|
19
|
+
- `Init` discovers local workspace materials, captures intent, initializes or refreshes `DECKS.json`, and creates conservative narrative state only from explicit user statements or source traces.
|
|
20
|
+
- `Research` runs closed loops to fill open story gaps, bind supported findings into canonical evidence, narrow overbroad claims/relations, and reduce caveats without crossing evidence boundaries.
|
|
21
|
+
- `Story` opens the read-only story workspace UI for inspecting claim flow, evidence strength, unsupported scope, caveats, objections, risks, research gaps, approval state, and affected artifacts.
|
|
22
|
+
- `Make` renders an artifact from approved or explicitly overridden narrative state. Supported 0.15 targets are deck and executive brief.
|
|
23
|
+
- `Refine` is the post-artifact workspace for reading, inspection, and targeted editing. Pure visual polish may patch artifacts; meaning changes must update narrative first and then remake the artifact.
|
|
24
|
+
|
|
25
|
+
Public command surface:
|
|
26
|
+
|
|
27
|
+
- `/revela init`
|
|
28
|
+
- `/revela research`
|
|
29
|
+
- `/revela story`
|
|
30
|
+
- `/revela make deck`
|
|
31
|
+
- `/revela make brief`
|
|
32
|
+
- `/revela refine`
|
|
33
|
+
- `/revela design`
|
|
34
|
+
|
|
35
|
+
Compatibility aliases:
|
|
36
|
+
|
|
37
|
+
- `/revela review` means a legacy story readiness report
|
|
38
|
+
- `/revela narrative` means `/revela story`
|
|
39
|
+
- `/revela deck` means `/revela make deck`
|
|
40
|
+
- `/revela brief` means `/revela make brief`
|
|
23
41
|
|
|
24
42
|
## Workspace State
|
|
25
43
|
|
|
26
44
|
Use `DECKS.json` as Revela's current compatibility workspace-state file. Do not write or patch it directly.
|
|
27
45
|
|
|
28
46
|
Use `revela-decks` for state operations:
|
|
47
|
+
|
|
29
48
|
- `read` to inspect current workspace state
|
|
30
49
|
- `init` to register discovered source material candidates during workspace initialization
|
|
31
|
-
- `upsertNarrative` to preserve canonical audience, decision, thesis, claims, evidence bindings, objections, and
|
|
32
|
-
- `
|
|
33
|
-
- `
|
|
50
|
+
- `upsertNarrative` to preserve canonical audience, decision, thesis, claims, evidence bindings, objections, risks, and research gaps
|
|
51
|
+
- `reviewNarrative` to run deterministic story readiness
|
|
52
|
+
- `deriveResearchGaps`, `upsertResearchGaps`, `updateResearchGap`, and `closeResearchGap` to manage research gap lifecycle
|
|
53
|
+
- `attachResearchFindings` to attach saved findings to research state
|
|
54
|
+
- `applyEvidenceCandidates` only when selected candidates should become canonical support
|
|
34
55
|
- `approveNarrative` only when the user explicitly approves or requests an override
|
|
56
|
+
- `compileDeckPlan`, `upsertDeck`, `upsertSlides`, and `review` only inside make-deck or artifact-readiness workflows
|
|
57
|
+
|
|
58
|
+
Never treat `writeReadiness.status`, old review snapshots, existing `decks/*.html`, workspace scans, extraction cache paths, or saved research actions as narrative approval or proof by themselves.
|
|
59
|
+
|
|
60
|
+
## Init Rules
|
|
61
|
+
|
|
62
|
+
During init:
|
|
63
|
+
|
|
64
|
+
- scan local workspace materials before asking broad questions
|
|
65
|
+
- reuse `workspace.sourceMaterials` and extraction cache when fingerprints match
|
|
66
|
+
- extract or read only relevant local materials; do not exhaustively process large workspaces
|
|
67
|
+
- derive claims, evidence bindings, caveats, unsupported scope, source paths, quotes/snippets, pages, sheets, or slide references only when explicit support exists
|
|
68
|
+
- ask the smallest missing intent questions after local evidence has been considered
|
|
69
|
+
- do not require slide count, design choice, layout choice, output path, or visual style unless the user explicitly asks to make an artifact immediately
|
|
70
|
+
|
|
71
|
+
## Research Rules
|
|
72
|
+
|
|
73
|
+
During research:
|
|
74
|
+
|
|
75
|
+
- start from open research gaps, unsupported central claims, objections, risks, and decision questions
|
|
76
|
+
- run multiple review/search/bind/narrow/re-review loops when useful, stopping when no public evidence can improve the state or after the workflow limit
|
|
77
|
+
- avoid generic internet research when workspace evidence already supports the claim
|
|
78
|
+
- delegate external web search to the `revela-research` subagent
|
|
79
|
+
- save findings through `revela-research-save`
|
|
80
|
+
- treat `/revela research` as permission to attach findings and bind clearly supported evidence without item-by-item user confirmation
|
|
81
|
+
- use `applyEvidenceCandidates` or `upsertNarrative` to create canonical evidence bindings when claim id, quote/snippet, source, support scope, unsupported scope, caveat, and strength are explicit
|
|
82
|
+
- narrow overbroad claim scope or relation rationale when the narrower wording preserves strategic meaning and better matches the evidence
|
|
83
|
+
- preserve source path, URL, location/page/sheet/slide, quote/snippet, support scope, unsupported scope, and caveat
|
|
84
|
+
- keep missing or partial evidence visible instead of filling it with model assumptions; classify remaining caveats as internal-data-needed, not-publicly-researchable, source-quality-limit, or still-open
|
|
35
85
|
|
|
36
|
-
|
|
86
|
+
## Story Rules
|
|
37
87
|
|
|
38
|
-
|
|
88
|
+
When the user invokes `/revela story`, open the read-only story workspace UI. Do not turn that command into a blocking readiness report.
|
|
39
89
|
|
|
40
|
-
When
|
|
90
|
+
When the user invokes `/revela review` or explicitly asks for a readiness report, call `revela-decks` action `reviewNarrative` and report the tool result as authoritative.
|
|
41
91
|
|
|
42
92
|
Use this report shape:
|
|
93
|
+
|
|
43
94
|
- `Narrative readiness: <status>`
|
|
44
95
|
- `Narrative hash: <hash>` when available
|
|
45
96
|
- blockers first, with issue type, claim text when available, and suggested next action
|
|
46
97
|
- warnings second, as residual risks
|
|
98
|
+
- research gaps and unattached findings as next work
|
|
47
99
|
- approval state last, clearly distinguishing `ready_for_approval`, `approved`, stale approval, and render override
|
|
48
100
|
|
|
49
101
|
If evidence is missing, say what is missing and what should happen next. Do not invent quotes, sources, page locations, URLs, caveats, or research findings.
|
|
50
102
|
|
|
51
|
-
If research findings were saved but not attached or bound, describe them as unattached research state, not proof.
|
|
52
|
-
|
|
53
103
|
If the narrative is ready for approval, ask the user whether to approve or revise it. Do not approve automatically.
|
|
54
104
|
|
|
105
|
+
## Make Rules
|
|
106
|
+
|
|
107
|
+
For `/revela make deck` and compatible deck handoff:
|
|
108
|
+
|
|
109
|
+
- switch to deck-render mode through the command workflow
|
|
110
|
+
- check narrative readiness and current approval before compiling deck specs
|
|
111
|
+
- use `compileDeckPlan` as the canonical narrative-to-deck planning path
|
|
112
|
+
- run the deck/artifact gate with `revela-decks review` before writing HTML
|
|
113
|
+
- fetch design layouts/components only after narrative handoff is valid
|
|
114
|
+
- keep the HTML deck contract valid: one `<section class="slide">` per slide, canonical 1-based `data-slide-index`, and matching `DECKS.json` slide specs
|
|
115
|
+
|
|
116
|
+
For `/revela make brief`, render the executive brief from canonical narrative state and graph-backed claim/evidence relationships, not from a deck summary.
|
|
117
|
+
|
|
118
|
+
If story readiness, approval, evidence, or artifact blockers remain, report the blocker and suggest `/revela review`, `/revela research`, or a targeted user answer. Do not bypass with invented state.
|
|
119
|
+
|
|
120
|
+
## Refine Rules
|
|
121
|
+
|
|
122
|
+
Use `/revela refine` for post-artifact reading, inspection, and editing.
|
|
123
|
+
|
|
124
|
+
- Reading should explain source, support strength, caveat, unsupported scope, narrative purpose, related risks/objections, research gaps, and artifact coverage.
|
|
125
|
+
- Pure artifact polish may stay artifact-level: layout, typography, spacing, crop, visual hierarchy, export mechanics, and deck contract fixes.
|
|
126
|
+
- Meaning-changing edits must update canonical narrative first, then run story readiness/approval or explicit override, then remake affected artifacts.
|
|
127
|
+
- Deprecated `/revela edit` and `/revela inspect` route to Refine.
|
|
128
|
+
|
|
129
|
+
## Design Surface
|
|
130
|
+
|
|
131
|
+
Use `/revela design` for visual-system work: list/use/new/edit/preview/install/remove designs.
|
|
132
|
+
|
|
133
|
+
Do not inject design CSS, layout catalogs, component indexes, chart rules, or deck HTML skeletons during init, research, or story. Fetch design context only for make-deck or explicit design-authoring workflows.
|
|
134
|
+
|
|
55
135
|
## Boundaries
|
|
56
136
|
|
|
57
137
|
- Do not write or overwrite `decks/*.html` in narrative mode.
|
|
58
|
-
- Do not call `revela-decks review` in
|
|
59
|
-
- Do not apply evidence candidates, bind evidence, or rewrite slide text unless the user explicitly asks.
|
|
60
|
-
- Do not fetch design CSS, layouts, components, chart rules, or HTML skeletons in narrative mode.
|
|
138
|
+
- Do not call `revela-decks review` in story mode; that is the deck/artifact gate.
|
|
139
|
+
- Do not apply evidence candidates, bind evidence, or rewrite slide text unless the user explicitly asks or the active workflow requires it with clear support.
|
|
61
140
|
- Do not store secrets, credentials, tokens, or sensitive personal information.
|
|
62
141
|
- Do not infer long-term user preferences from one-off tasks.
|
|
63
|
-
|
|
64
|
-
When the user wants deck/artifact readiness, direct them to `/revela deck --review`. When they want to render a deck, wait for the explicit deck workflow.
|
|
142
|
+
- If source support is missing, keep the gap visible instead of making the claim sound proven.
|
package/skill/SKILL.md
CHANGED
|
@@ -374,7 +374,7 @@ After the user confirms the slide plan, update `DECKS.json` through `revela-deck
|
|
|
374
374
|
3. Call `revela-designs` tool with `action: "read"` and `component` set to ALL component
|
|
375
375
|
names you plan to use (comma-separated, e.g. `component: "card,stat-card,evidence-list"`).
|
|
376
376
|
4. Use `revela-decks` action `upsertDeck` to mark `requiredInputs.designLayoutsFetched` complete.
|
|
377
|
-
5. Run `/revela review` or call `revela-decks` action `review` yourself. The tool must compute readiness from `DECKS.json`.
|
|
377
|
+
5. Run `/revela make deck --review` or call `revela-decks` action `review` yourself. The tool must compute readiness from `DECKS.json`.
|
|
378
378
|
6. Use `revela-decks` action `read` and confirm `writeReadiness.status` is `ready` with no blockers.
|
|
379
379
|
7. Generate HTML that **exactly matches** the fetched examples — copy the HTML structure verbatim.
|
|
380
380
|
|