@cyber-dash-tech/revela 0.18.14 → 0.18.16

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.
@@ -12,9 +12,10 @@ Use this skill when the user asks to make, generate, render, or update a Revela
12
12
  - Deck execution planning comes from canonical `deck-plan.md`.
13
13
  - Local materials, material reviews, `researches/`, `assets/`, and user intent provide source context.
14
14
  - Slide argument copy comes from `deck-plan.md` `Claim`, `Reasoning`, and `Audience takeaway` fields when present; raw findings are evidence/source context, not default body copy.
15
- - Active/requested design tools define valid layouts, slots, components, nesting hints, and HTML writing rules.
15
+ - Active/requested design tools define valid layouts, slots, components, nesting hints, structure contracts, and HTML writing rules.
16
16
  - Active/requested domain guidance may inform communication framing, but it is not source evidence.
17
17
  - Generated artifacts live under `decks/*.html`.
18
+ - After final Artifact QA passes, reply with the generated HTML deck as a standalone website link/card that opens in Codex Browser for native browsing and annotation.
18
19
  - Do not require a Narrative Vault before generating a deck.
19
20
  - This skill does not own normal plan authoring; `revela-research` owns source preparation and `deck-plan.md` planning handoff.
20
21
  - `deck-plan.md` is required for normal deck generation.
@@ -42,13 +43,14 @@ Before render preflight:
42
43
  1. Call `revela_design_list`.
43
44
  2. Call `revela_design_read` with `section: "rules"` for the active/requested design.
44
45
  3. Call `revela_design_inventory`.
46
+ 4. Review each component's `contract` field. Components with structure contracts must be planned from structured content and rendered with the required internal DOM/classes, not simplified freehand markup.
45
47
 
46
48
  Before HTML writing:
47
49
 
48
50
  1. Call `revela_read_deck_plan`.
49
51
  2. Read the returned `htmlWritingBatches`.
50
52
  3. Call `revela_design_read_layout` for each layout used in the current batch.
51
- 4. Call `revela_design_read_component` for each component used in the current batch.
53
+ 4. Call `revela_design_read_component` for each component used in the current batch. For contract components, treat the returned CSS/HTML as executable grammar and preserve the required root, descendant, item, and alternating classes.
52
54
  5. Fetch chart rules before creating or modifying ECharts.
53
55
 
54
56
  ## Plan Preflight And Repair
@@ -81,12 +83,15 @@ Use this phase when the user asks to make, generate, render, or update an HTML d
81
83
  9. Preserve positive 1-based `data-slide-index` values.
82
84
  10. Every slide must have exactly one direct `.slide-canvas` child.
83
85
  11. Keep the HTML valid after each write.
84
- 12. After every HTML write, call `revela_run_deck_qa` and repair hard errors before continuing, review, or export.
86
+ 12. After every HTML write, call `revela_run_deck_qa` and repair hard errors before continuing or export.
87
+ 13. After the final `revela_run_deck_qa` passes with zero hard errors, reply with a standalone Markdown link to the generated HTML deck artifact so Codex renders an Open in Browser website card.
88
+ 14. Prefer an absolute `file://` URL for the card. If the card or direct file navigation is unavailable, start a read-only local static server from the workspace root and use the exact `http://127.0.0.1:<port>/decks/<file>.html` URL.
85
89
 
86
90
  ## Outputs
87
91
 
88
92
  - `decks/*.html`.
89
93
  - Artifact QA status.
94
+ - Website card/link for the QA-passed HTML deck.
90
95
  - Unresolved render/design issues and any plan diagnostics that require `revela-research` Planning Handoff.
91
96
 
92
97
  ## Must Not
@@ -96,6 +101,7 @@ Use this phase when the user asks to make, generate, render, or update an HTML d
96
101
  - Do not write a new `deck-plan.md` when it is missing.
97
102
  - Do not use design inventory names, slots, or components that were not returned by the active/requested design tools.
98
103
  - Do not use a slot that does not belong to the selected layout.
104
+ - Do not hand-roll simplified internal DOM for contract components such as timelines. If the required structure cannot be satisfied, choose a simpler valid component or stop with the contract issue.
99
105
  - Do not patch more than 5 slide sections in one HTML write.
100
106
  - Do not invent source links, quotes, URLs, page references, caveats, or licenses.
101
107
  - Do not write remote image candidates directly into deck HTML; save them as workspace assets first.
@@ -49,6 +49,7 @@ Use this skill when the user asks to start from a goal, inspect local materials,
49
49
  - Call `revela_design_list`.
50
50
  - Call `revela_design_read` with `section: "rules"` for the active/requested design.
51
51
  - Call `revela_design_inventory`.
52
+ - When a chosen component has a `contract` field, preserve that contract in the visual brief/render notes so Make Deck renders the required internal structure instead of a simplified lookalike.
52
53
  - Write `deck-plan.md` directly from reviewed materials, saved findings, assets, user intent, active domain framing, and active design vocabulary.
53
54
  - Call `revela_read_deck_plan` after writing `deck-plan.md`.
54
55
  - If diagnostics report `sourceLinks`, layout, slot, component, or `children` issues, patch `deck-plan.md` directly and call `revela_read_deck_plan` again.
package/skill/SKILL.md CHANGED
@@ -143,6 +143,9 @@ Rules for the slide plan:
143
143
  - Use exact layout names from the Layout Index and exact component names from
144
144
  the Component Index. Use only slots returned by the selected layout inventory.
145
145
  Do not invent layout, slot, or component names.
146
+ - Components marked in the Component Index Contract column have mandatory
147
+ internal structure. Preserve their required DOM/classes in render notes and
148
+ HTML generation; do not describe them as generic visual ideas.
146
149
  - Use `box.children` when several child components support one semantic idea.
147
150
  Do not duplicate a child component both inside `box.children` and as a
148
151
  separate top-level component plan entry.
@@ -217,8 +220,11 @@ Before writing or materially changing HTML:
217
220
  layout names, comma-separated.
218
221
  5. Call `revela-designs` with `action: "read"` and `component` set to all
219
222
  required component names, comma-separated.
220
- 6. Fetch `section: "chart-rules"` before using ECharts.
221
- 7. Do not update legacy `requiredInputs`; design fetching is an execution step,
223
+ 6. For any component with a Contract marker, copy the fetched component
224
+ structure closely and keep its required root, descendant, item, and
225
+ alternating classes.
226
+ 7. Fetch `section: "chart-rules"` before using ECharts.
227
+ 8. Do not update legacy `requiredInputs`; design fetching is an execution step,
222
228
  not a workflow permission gate.
223
229
 
224
230
  Never generate HTML from memory or prior knowledge of a design. Copy the fetched
@@ -279,6 +285,9 @@ The active design defines a closed vocabulary of layouts and components.
279
285
 
280
286
  - Every slide must use exactly one layout class from the Layout Index.
281
287
  - Every content block must use component classes from the Component Index.
288
+ - Contract components must satisfy their fetched structure contract. Do not
289
+ replace a timeline, roadmap, chart frame, or other structured component with
290
+ a visual approximation that only resembles it.
282
291
  - Do not invent layout classes, component names, CSS variables, custom grids, or
283
292
  custom visual effects.
284
293
  - Do not define new class rules in the deck `<style>` block unless the fetched
@@ -1,46 +0,0 @@
1
- ---
2
- name: revela-review
3
- description: Open the Revela Review UI or read deck diagnostics for generated HTML deck artifacts in Codex.
4
- ---
5
-
6
- # Revela Review
7
-
8
- Use this skill when the user asks to review, diagnose, QA, or refine a generated Revela deck.
9
-
10
- ## Contract
11
-
12
- - Review is the post-artifact surface for generated `decks/*.html`.
13
- - A plain review request opens the Review UI.
14
- - Diagnostics are read explicitly when the user asks for QA details, export readiness, or no-GUI output.
15
- - Review UI is QA + Leave Comment / Apply. Insight/Inspect is removed from the public Review path.
16
-
17
- ## Preconditions
18
-
19
- - A target `decks/*.html` file exists.
20
- - If multiple deck candidates exist and the user did not specify one, choose the most recent or most clearly requested deck and state the choice.
21
-
22
- ## Inputs
23
-
24
- - HTML deck path.
25
- - Optional user review/refine intent.
26
-
27
- ## Workflow
28
-
29
- 1. Resolve the target `decks/*.html` file from the user request or unambiguous workspace state.
30
- 2. For a plain review request, call `revela_review_deck_open` and let the tool open the browser by default.
31
- 3. Use `revela_review_deck_read`, normally with `format: "markdown"`, only when the user explicitly asks for diagnostics, QA details, export readiness, or no-GUI output.
32
- 4. Do not call `revela_run_deck_qa` separately for a normal Review UI open.
33
- 5. Pure visual/layout/export fixes may patch artifacts directly when the user asks for a change, but read active design rules first with `revela_design_read` using `section: "rules"`.
34
- 6. Content changes that affect the deck argument should update `deck-plan.md` first, then remake the deck.
35
-
36
- ## Outputs
37
-
38
- - Review UI URL/open state.
39
- - Or Markdown/JSON diagnostics and current readiness summary.
40
-
41
- ## QA Notes
42
-
43
- - `revela_review_deck_read` is read-only: it must not mutate deck HTML, `deck-plan.md`, assets, or compatibility state.
44
- - `revela_review_deck_open` returns URL/token/open state and basic file metadata.
45
- - Repair hard QA errors before treating a deck as review-ready.
46
- - Deck slides must use `<section class="slide" ...>` with exactly one direct `.slide-canvas` child.