@cyber-dash-tech/revela 0.18.4 → 0.18.6
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 +7 -5
- package/README.zh-CN.md +7 -5
- package/lib/commands/refine.ts +1 -1
- package/lib/refine/comment-requests.ts +1 -1
- package/lib/refine/prompt-bridge.ts +94 -25
- package/lib/refine/review-comments.ts +203 -0
- package/lib/refine/server.ts +1073 -216
- package/package.json +1 -1
- package/plugins/revela/.mcp.json +1 -1
- package/plugins/revela/mcp/revela-server.ts +1 -1
- package/plugins/revela/skills/revela-export/SKILL.md +30 -1
- package/plugins/revela/skills/revela-helper/SKILL.md +52 -0
- package/plugins/revela/skills/revela-make-deck/SKILL.md +83 -17
- package/plugins/revela/skills/revela-research/SKILL.md +86 -15
- package/plugins/revela/skills/{revela-review-deck → revela-review}/SKILL.md +28 -7
- package/plugins/revela/skills/revela-design/SKILL.md +0 -46
- package/plugins/revela/skills/revela-domain/SKILL.md +0 -30
- package/plugins/revela/skills/revela-init/SKILL.md +0 -31
- package/plugins/revela/skills/revela-upgrade/SKILL.md +0 -33
package/package.json
CHANGED
package/plugins/revela/.mcp.json
CHANGED
|
@@ -283,7 +283,7 @@ const tools = [
|
|
|
283
283
|
inputSchema: objectSchema({
|
|
284
284
|
workspaceRoot: stringProp("Optional workspace root."),
|
|
285
285
|
file: requiredStringProp("Workspace-relative or absolute HTML deck path."),
|
|
286
|
-
bridge: enumProp(["codex-exec"], "Prompt bridge for browser
|
|
286
|
+
bridge: enumProp(["codex-exec"], "Prompt bridge for browser saved-comment Apply interactions."),
|
|
287
287
|
openBrowser: booleanProp("Whether the tool should open the browser itself. Defaults to true when omitted."),
|
|
288
288
|
}, ["file"]),
|
|
289
289
|
},
|
|
@@ -7,6 +7,23 @@ description: Export Revela deck artifacts from Codex to PDF, PPTX, or PNG.
|
|
|
7
7
|
|
|
8
8
|
Use this skill when the user asks to export a Revela deck.
|
|
9
9
|
|
|
10
|
+
## Contract
|
|
11
|
+
|
|
12
|
+
- Export converts generated HTML decks to PDF, PPTX, or per-slide PNG files.
|
|
13
|
+
- The target deck should be export-ready before export.
|
|
14
|
+
- If the latest visible QA result has hard errors, repair them before treating the deck as export-ready.
|
|
15
|
+
|
|
16
|
+
## Preconditions
|
|
17
|
+
|
|
18
|
+
- A target `decks/*.html` file exists.
|
|
19
|
+
- The requested format is `pdf`, `pptx`, or `png`.
|
|
20
|
+
- Latest QA should have no hard errors.
|
|
21
|
+
|
|
22
|
+
## Inputs
|
|
23
|
+
|
|
24
|
+
- HTML deck path.
|
|
25
|
+
- Export format: `pdf`, `pptx`, or `png`.
|
|
26
|
+
|
|
10
27
|
## Workflow
|
|
11
28
|
|
|
12
29
|
1. Resolve the target HTML deck path.
|
|
@@ -15,6 +32,18 @@ Use this skill when the user asks to export a Revela deck.
|
|
|
15
32
|
4. For per-slide PNG files, call `revela_export_png`.
|
|
16
33
|
5. Report output path(s), slide count, or export errors.
|
|
17
34
|
|
|
35
|
+
## Outputs
|
|
36
|
+
|
|
37
|
+
- PDF path.
|
|
38
|
+
- PPTX path.
|
|
39
|
+
- Per-slide PNG directory/path list.
|
|
40
|
+
- Slide count or export error.
|
|
41
|
+
|
|
42
|
+
## Must Not
|
|
43
|
+
|
|
44
|
+
- Do not claim a deck with hard QA errors is export-ready.
|
|
45
|
+
- Do not silently ignore browser launch, screenshot, PDF, PPTX, or PNG export failures.
|
|
46
|
+
|
|
18
47
|
`revela_run_deck_qa`, `revela_export_pdf`, `revela_export_pptx`, and `revela_export_png` may launch a browser. In sandboxed Codex sessions, request user-approved command escalation when the browser cannot start inside the default sandbox.
|
|
19
48
|
|
|
20
|
-
Post-write hooks and explicit QA tools surface Artifact QA failures.
|
|
49
|
+
Post-write hooks and explicit QA tools surface Artifact QA failures.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: revela-helper
|
|
3
|
+
description: Explain Revela, inspect the current Revela workspace status, and report active design/domain guidance in Codex.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Revela Helper
|
|
7
|
+
|
|
8
|
+
Use this skill when the user asks what Revela is, what the current workspace state is, which design or domain is active, which Revela capabilities are available, or what the next step should be.
|
|
9
|
+
|
|
10
|
+
## Contract
|
|
11
|
+
|
|
12
|
+
- This is a read-only helper and orientation surface.
|
|
13
|
+
- It may inspect runtime, design, domain, and workspace artifact status.
|
|
14
|
+
- It must not perform research, write files, create `deck-plan.md`, generate decks, open Review UI, or export artifacts.
|
|
15
|
+
- Keep the answer short and operational.
|
|
16
|
+
|
|
17
|
+
## Preconditions
|
|
18
|
+
|
|
19
|
+
- None. This skill can run in any workspace.
|
|
20
|
+
|
|
21
|
+
## Inputs
|
|
22
|
+
|
|
23
|
+
- User questions about Revela, current status, active design/domain, or next workflow step.
|
|
24
|
+
- Optional workspace context such as existing `researches/`, `deck-plan.md`, `decks/*.html`, and `assets/`.
|
|
25
|
+
|
|
26
|
+
## Required Tools
|
|
27
|
+
|
|
28
|
+
1. Call `revela_doctor` to inspect the running Revela runtime and workspace.
|
|
29
|
+
2. Call `revela_design_list` to identify the active design and available designs.
|
|
30
|
+
3. Call `revela_domain_list` to identify the active domain and available domains.
|
|
31
|
+
4. Use `revela_design_read` or `revela_domain_read` only when the user asks for design/domain detail or when a concise summary is needed to recommend the next workflow.
|
|
32
|
+
|
|
33
|
+
## Output
|
|
34
|
+
|
|
35
|
+
Report:
|
|
36
|
+
|
|
37
|
+
- What Revela does: trusted, traceable, deck-first decision artifacts from local materials, research, data, and user intent.
|
|
38
|
+
- Runtime/version status from `revela_doctor`.
|
|
39
|
+
- Active design and active domain.
|
|
40
|
+
- Workspace artifact status: whether `researches/`, `deck-plan.md`, `decks/*.html`, and `assets/` appear available.
|
|
41
|
+
- Recommended next step:
|
|
42
|
+
- No `researches/`: run `revela-research`.
|
|
43
|
+
- Research exists but no `deck-plan.md`: continue `revela-research` to the Planning Handoff.
|
|
44
|
+
- Valid `deck-plan.md` but no deck artifact: run `revela-make-deck`.
|
|
45
|
+
- Existing deck artifact: run `revela-review` or `revela-export` depending on the user goal.
|
|
46
|
+
|
|
47
|
+
## Must Not
|
|
48
|
+
|
|
49
|
+
- Do not write or patch files.
|
|
50
|
+
- Do not do external web research.
|
|
51
|
+
- Do not generate or repair `deck-plan.md`.
|
|
52
|
+
- Do not generate, review, patch, or export deck artifacts.
|
|
@@ -1,32 +1,98 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: revela-make-deck
|
|
3
|
-
description:
|
|
3
|
+
description: Generate Revela HTML deck artifacts in Codex from an existing deck-plan.md and active design files.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Revela Make Deck
|
|
7
7
|
|
|
8
|
-
Use this skill when the user asks to
|
|
8
|
+
Use this skill when the user asks to make, generate, render, or update a Revela HTML deck from an existing `deck-plan.md`.
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Contract
|
|
11
11
|
|
|
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
|
+
- Active/requested design tools define valid layouts, slots, components, nesting hints, and HTML writing rules.
|
|
15
|
+
- Active/requested domain guidance may inform communication framing, but it is not source evidence.
|
|
14
16
|
- Generated artifacts live under `decks/*.html`.
|
|
15
|
-
- Do not require a Narrative Vault before
|
|
17
|
+
- Do not require a Narrative Vault before generating a deck.
|
|
18
|
+
- This skill does not own normal plan authoring; `revela-research` owns source preparation and `deck-plan.md` planning handoff.
|
|
19
|
+
- `deck-plan.md` is required for normal deck generation.
|
|
16
20
|
|
|
17
|
-
##
|
|
21
|
+
## Preconditions
|
|
18
22
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
5. For new HTML files, call `revela_create_deck_foundation`.
|
|
24
|
-
6. Before patching slide HTML, read the specific layouts/components with `revela_design_read_layout` and `revela_design_read_component`; fetch chart rules before ECharts.
|
|
25
|
-
7. Patch slides into the foundation between Revela slide markers. Preserve positive 1-based `data-slide-index` values. Every slide must have exactly one direct `.slide-canvas` child.
|
|
26
|
-
8. Generate one `htmlWritingBatches` entry at a time. A single HTML write/edit/apply_patch may add or rewrite at most 5 slide sections. If a chapter is longer than 5 slides, use the consecutive batch parts returned by `revela_read_deck_plan`.
|
|
27
|
-
9. Keep the HTML valid after each write.
|
|
28
|
-
10. After every HTML write, call `revela_run_deck_qa` and repair hard errors before review or export.
|
|
23
|
+
- Required: readable `deck-plan.md`.
|
|
24
|
+
- An active or user-requested design must be readable.
|
|
25
|
+
- If `deck-plan.md` is missing, stop and tell the user to run `revela-research` or continue `revela-research` to the Planning Handoff.
|
|
26
|
+
- If `deck-plan.md` is structurally invalid, only repair technical plan diagnostics reported during render preflight.
|
|
29
27
|
|
|
30
|
-
##
|
|
28
|
+
## Inputs
|
|
31
29
|
|
|
32
|
-
|
|
30
|
+
- `researches/**/*.md`
|
|
31
|
+
- Reviewed workspace materials and material review records.
|
|
32
|
+
- `assets/`
|
|
33
|
+
- User deck objective, audience, and constraints.
|
|
34
|
+
- Existing `deck-plan.md`.
|
|
35
|
+
- Active/requested design and optional active/requested domain.
|
|
36
|
+
|
|
37
|
+
## Required Design Tools
|
|
38
|
+
|
|
39
|
+
Before render preflight:
|
|
40
|
+
|
|
41
|
+
1. Call `revela_design_list`.
|
|
42
|
+
2. Call `revela_design_read` with `section: "rules"` for the active/requested design.
|
|
43
|
+
3. Call `revela_design_inventory`.
|
|
44
|
+
|
|
45
|
+
Before HTML writing:
|
|
46
|
+
|
|
47
|
+
1. Call `revela_read_deck_plan`.
|
|
48
|
+
2. Read the returned `htmlWritingBatches`.
|
|
49
|
+
3. Call `revela_design_read_layout` for each layout used in the current batch.
|
|
50
|
+
4. Call `revela_design_read_component` for each component used in the current batch.
|
|
51
|
+
5. Fetch chart rules before creating or modifying ECharts.
|
|
52
|
+
|
|
53
|
+
## Plan Preflight And Repair
|
|
54
|
+
|
|
55
|
+
Call `revela_read_deck_plan` before HTML generation and treat the result as the render blueprint.
|
|
56
|
+
|
|
57
|
+
Allowed plan repairs are limited to technical diagnostics from `revela_read_deck_plan`:
|
|
58
|
+
|
|
59
|
+
- Broken Markdown/frontmatter structure.
|
|
60
|
+
- Invalid or missing `sourceLinks` field structure, without adding new unsupported source links.
|
|
61
|
+
- Layout, slot, component, or `children` names that do not match `revela_design_inventory`.
|
|
62
|
+
- Component nesting fixes such as using `box.children` when the selected component model requires nested semantic groups.
|
|
63
|
+
|
|
64
|
+
Do not redesign the argument structure, add new slides, remove supported slides, rewrite claims, or add source links that were not reviewed or saved by `revela-research`. If normal plan authoring is needed, stop and send the user back to `revela-research` Planning Handoff.
|
|
65
|
+
|
|
66
|
+
## Render Phase
|
|
67
|
+
|
|
68
|
+
Use this phase when the user asks to make, generate, render, or update an HTML deck and `deck-plan.md` is readable.
|
|
69
|
+
|
|
70
|
+
1. Call `revela_read_deck_plan` before HTML generation and follow the current projection.
|
|
71
|
+
2. Read `htmlWritingBatches` before any HTML write. `revela_read_deck_plan` is QA/diagnostics, not a writer.
|
|
72
|
+
3. For new HTML files, call `revela_create_deck_foundation`.
|
|
73
|
+
4. Generate one `htmlWritingBatches` entry at a time.
|
|
74
|
+
5. A single HTML write/edit/apply_patch may add or rewrite at most 5 slide sections.
|
|
75
|
+
6. If a chapter is longer than 5 slides, use the consecutive batch parts returned by `revela_read_deck_plan`.
|
|
76
|
+
7. Patch slides into the foundation between Revela slide markers.
|
|
77
|
+
8. Preserve positive 1-based `data-slide-index` values.
|
|
78
|
+
9. Every slide must have exactly one direct `.slide-canvas` child.
|
|
79
|
+
10. Keep the HTML valid after each write.
|
|
80
|
+
11. After every HTML write, call `revela_run_deck_qa` and repair hard errors before continuing, review, or export.
|
|
81
|
+
|
|
82
|
+
## Outputs
|
|
83
|
+
|
|
84
|
+
- `decks/*.html`.
|
|
85
|
+
- Artifact QA status.
|
|
86
|
+
- Unresolved render/design issues and any plan diagnostics that require `revela-research` Planning Handoff.
|
|
87
|
+
|
|
88
|
+
## Must Not
|
|
89
|
+
|
|
90
|
+
- Do not skip or synthesize `deck-plan.md` for normal decks.
|
|
91
|
+
- Do not claim ownership of normal plan authoring.
|
|
92
|
+
- Do not write a new `deck-plan.md` when it is missing.
|
|
93
|
+
- Do not use design inventory names, slots, or components that were not returned by the active/requested design tools.
|
|
94
|
+
- Do not use a slot that does not belong to the selected layout.
|
|
95
|
+
- Do not patch more than 5 slide sections in one HTML write.
|
|
96
|
+
- Do not invent source links, quotes, URLs, page references, caveats, or licenses.
|
|
97
|
+
- Do not write remote image candidates directly into deck HTML; save them as workspace assets first.
|
|
98
|
+
- Do not require a Narrative Vault.
|
|
@@ -1,29 +1,100 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: revela-research
|
|
3
|
-
description: Research
|
|
3
|
+
description: Research workspace materials and public sources for a Revela deck objective, using active domain/design guidance to save source-linked findings and hand off deck-plan.md.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Revela Research
|
|
7
7
|
|
|
8
|
-
Use this skill when the user asks to research missing
|
|
8
|
+
Use this skill when the user asks to start from a goal, inspect local materials, research missing inputs, gather public support, save findings, find source-linked examples/assets, or prepare the deck planning handoff.
|
|
9
9
|
|
|
10
10
|
## Contract
|
|
11
11
|
|
|
12
|
-
- Research
|
|
13
|
-
-
|
|
14
|
-
-
|
|
12
|
+
- Research is the source-preparation workflow for Codex Revela.
|
|
13
|
+
- Research output is saved under `researches/**/*.md` and, when the user goal is a deck and materials are sufficient, handed off as `deck-plan.md`.
|
|
14
|
+
- Local materials are only usable after direct text review or extracted read-view review.
|
|
15
|
+
- Active/requested domain guidance informs audience, decision framing, claim standards, evidence expectations, objection/risk interpretation, and research-gap priority.
|
|
16
|
+
- Domain guidance is not evidence and must never be cited as proof for factual claims.
|
|
17
|
+
- Active/requested design tools define valid layouts, slots, components, nesting hints, and deck-plan design vocabulary.
|
|
18
|
+
- `deck-plan.md` is the formal research-to-make-deck handoff when a deck objective is sufficiently supported.
|
|
19
|
+
- Do not create deck artifacts, a Narrative Vault, or canonical evidence bindings during research.
|
|
15
20
|
- Do not invent URLs, quotes, page references, numbers, caveats, or licenses.
|
|
16
21
|
|
|
17
|
-
##
|
|
22
|
+
## Preconditions
|
|
23
|
+
|
|
24
|
+
- The user provides at least one of: objective, topic, audience, decision/action, source materials, or deck intent.
|
|
25
|
+
- If intent is unclear, inspect the workspace first and ask only the smallest missing high-impact questions.
|
|
26
|
+
|
|
27
|
+
## Inputs
|
|
28
|
+
|
|
29
|
+
- User objective, constraints, audience, decision/action, and language preference when available.
|
|
30
|
+
- Workspace materials, extracted material read views, existing `researches/**/*.md`, existing `deck-plan.md`, and `assets/`.
|
|
31
|
+
- Active or user-requested domain guidance.
|
|
32
|
+
- Optional external public sources when needed and allowed.
|
|
33
|
+
|
|
34
|
+
## Required Tool Order
|
|
35
|
+
|
|
36
|
+
1. Call `revela_domain_list`.
|
|
37
|
+
2. Call `revela_domain_read` for the active domain or user-requested domain.
|
|
38
|
+
3. Call `revela_prepare_local_materials`.
|
|
39
|
+
4. For Office/PDF sources, read the provided `allowedReadPath` / `read_view_path`; if missing, call `revela_extract_document_materials`.
|
|
40
|
+
5. Read original text/Markdown/CSV files or extracted read views before treating a material as usable.
|
|
41
|
+
6. Call `revela_record_material_review` for each reviewed Office/PDF source.
|
|
42
|
+
7. Call `revela_check_material_intake` before reporting research readiness.
|
|
43
|
+
8. Use external research only for public facts, user-authorized questions, or gaps not covered by local materials.
|
|
44
|
+
9. Save useful findings with `revela_research_save`.
|
|
45
|
+
10. For deck goals with sufficient materials, run Planning Handoff:
|
|
46
|
+
- Call `revela_design_list`.
|
|
47
|
+
- Call `revela_design_read` with `section: "rules"` for the active/requested design.
|
|
48
|
+
- Call `revela_design_inventory`.
|
|
49
|
+
- Write `deck-plan.md` directly from reviewed materials, saved findings, assets, user intent, active domain framing, and active design vocabulary.
|
|
50
|
+
- Call `revela_read_deck_plan` after writing `deck-plan.md`.
|
|
51
|
+
- If diagnostics report `sourceLinks`, layout, slot, component, or `children` issues, patch `deck-plan.md` directly and call `revela_read_deck_plan` again.
|
|
52
|
+
|
|
53
|
+
## Finding Requirements
|
|
54
|
+
|
|
55
|
+
Each saved finding should include:
|
|
56
|
+
|
|
57
|
+
- Source URL or workspace path.
|
|
58
|
+
- Quote/snippet or explicit note when no exact quote is available.
|
|
59
|
+
- What it supports.
|
|
60
|
+
- What it does not support.
|
|
61
|
+
- Caveat or limitation.
|
|
62
|
+
- Date checked.
|
|
63
|
+
- Optional image/logo/screenshot leads with known source and license/attribution status.
|
|
18
64
|
|
|
19
|
-
|
|
20
|
-
2. Identify the smallest research tasks needed for the deck objective: market facts, benchmarks, examples, source quotes, images/logos/screenshots, or caveats.
|
|
21
|
-
3. Use external research only for public facts or user-authorized questions.
|
|
22
|
-
4. Save useful findings with `revela_research_save`.
|
|
23
|
-
5. Each finding should include source URL/path, quote/snippet, what it supports, what it does not support, caveat, date checked, and optional image leads.
|
|
24
|
-
6. If a finding is context only, label it as context and do not present it as proof.
|
|
65
|
+
If a finding is context only, label it as context and do not present it as proof.
|
|
25
66
|
|
|
26
|
-
##
|
|
67
|
+
## Outputs
|
|
27
68
|
|
|
28
|
-
-
|
|
29
|
-
-
|
|
69
|
+
- `researches/{topic}/{filename}.md`
|
|
70
|
+
- Material review records for reviewed Office/PDF sources.
|
|
71
|
+
- `deck-plan.md` when the user goal is a deck and reviewed materials/findings are sufficient for a traceable plan.
|
|
72
|
+
- Source limitations and unresolved gaps.
|
|
73
|
+
- A clear statement of whether `revela-make-deck` can proceed or whether more research is needed.
|
|
74
|
+
|
|
75
|
+
## Planning Handoff
|
|
76
|
+
|
|
77
|
+
Use this final stage only for deck goals. If sources are too thin, report unresolved inputs and source limitations instead of drafting unsupported slides.
|
|
78
|
+
|
|
79
|
+
Every `deck-plan.md` handoff should include Cover, Table of Contents, Closing, 3-5 chapter headings, explicit slide ranges, and `---` slide separators under `## Slides`.
|
|
80
|
+
|
|
81
|
+
Each non-structural slide block must include:
|
|
82
|
+
|
|
83
|
+
- Slide title and role when relevant.
|
|
84
|
+
- `#### Content Plan`
|
|
85
|
+
- `#### Source Links` for materials, findings, assets, URLs, and caveats.
|
|
86
|
+
- `#### Design Plan`
|
|
87
|
+
- Selected layout from design inventory.
|
|
88
|
+
- Component plan using component names from design inventory.
|
|
89
|
+
- Valid slots from the selected layout.
|
|
90
|
+
- Valid component nesting hints, including `box.children` when multiple child components support one semantic idea.
|
|
91
|
+
- Unresolved inputs, source limitations, and user review notes instead of AI-authored caveat/risk judgement.
|
|
92
|
+
|
|
93
|
+
Do not duplicate the same child as both nested and top-level. Do not add source links that were not reviewed or saved during research.
|
|
94
|
+
|
|
95
|
+
## Must Not
|
|
96
|
+
|
|
97
|
+
- Do not generate `revela-narrative/`.
|
|
98
|
+
- Do not write `decks/*.html`.
|
|
99
|
+
- Do not bind findings into a Narrative Vault or canonical evidence graph.
|
|
100
|
+
- Do not treat domain guidance as source evidence.
|
|
@@ -1,21 +1,42 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: revela-review
|
|
3
|
-
description:
|
|
2
|
+
name: revela-review
|
|
3
|
+
description: Open the Revela Review UI or read deck diagnostics for generated HTML deck artifacts in Codex.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# Revela Review
|
|
6
|
+
# Revela Review
|
|
7
7
|
|
|
8
8
|
Use this skill when the user asks to review, diagnose, QA, or refine a generated Revela deck.
|
|
9
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
|
+
|
|
10
27
|
## Workflow
|
|
11
28
|
|
|
12
29
|
1. Resolve the target `decks/*.html` file from the user request or unambiguous workspace state.
|
|
13
30
|
2. For a plain review request, call `revela_review_deck_open` and let the tool open the browser by default.
|
|
14
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.
|
|
15
|
-
4.
|
|
16
|
-
5.
|
|
17
|
-
6.
|
|
18
|
-
|
|
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.
|
|
19
40
|
|
|
20
41
|
## QA Notes
|
|
21
42
|
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: revela-design
|
|
3
|
-
description: Use Revela design guidance in Codex for deck planning and artifact generation.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Revela Design
|
|
7
|
-
|
|
8
|
-
Use this skill when the user asks about Revela designs or when generating deck HTML.
|
|
9
|
-
|
|
10
|
-
## Workflow
|
|
11
|
-
|
|
12
|
-
1. Call `revela_design_list` to inspect installed designs.
|
|
13
|
-
2. Call `revela_design_read` with `section: "rules"` before writing or patching `decks/*.html`; this records the Codex hook context required for deck writes.
|
|
14
|
-
3. Call `revela_design_inventory` before authoring or repairing `deck-plan.md` so planned layout names, slots, component names, and nesting hints come from the active design. Write slide plan Markdown directly, then call `revela_read_deck_plan` for diagnostics.
|
|
15
|
-
4. Read required details with `revela_design_read_layout` and `revela_design_read_component` before writing slide HTML that uses those layouts/components.
|
|
16
|
-
5. When the user asks to switch designs for future work, call `revela_design_activate` with the requested design name, then read the active design again.
|
|
17
|
-
6. For one-off deck generation with a requested design, read that design by name, call `revela_design_inventory` with that name, and pass `designName` to `revela_create_deck_foundation` without changing active design unless the user asked to switch.
|
|
18
|
-
7. Use the current simplified built-in design grammar: `box`, `text-panel`, `media`, `echart-panel`, `data-table`, `steps`, `roadmap-horizontal`, `roadmap-vertical`, `hero`, `stat-card`, `quote`, `toc`, `page-number`, and `brand-watermark`.
|
|
19
|
-
8. Fetch chart/design guidance before creating ECharts or complex layouts.
|
|
20
|
-
9. Do not invent unsupported component names.
|
|
21
|
-
|
|
22
|
-
Deck HTML must keep exactly one direct `.slide-canvas` child inside every `<section class="slide" ...>`; place `.page` or layout containers inside `.slide-canvas`, not directly under `.slide`.
|
|
23
|
-
|
|
24
|
-
Design changes are visual/artifact-level unless they change claim meaning, evidence boundaries, decision, or recommendation.
|
|
25
|
-
|
|
26
|
-
## Inventory-First Planning
|
|
27
|
-
|
|
28
|
-
Deck planning uses design vocabulary before HTML. Inspect the inventory, choose a valid layout for each slide, and choose valid component names for each planned element. Every top-level component plan must use a `slot` returned by the selected layout's inventory entry, plus a non-empty kebab-case `position` such as `left-top`, `left-middle`, `right-bottom`, `center`, or `overlay-top-right`.
|
|
29
|
-
|
|
30
|
-
Use `box` as the semantic container when several child components support one idea. Put children under `box.children`; do not repeat those child components as separate top-level component plan entries. `hero` is fullbleed-only, while `page-number` and `brand-watermark` are utilities.
|
|
31
|
-
|
|
32
|
-
Use `placementNote` for natural-language placement detail when slot and position are not enough. Slot and position are planning anchors; before HTML generation, fetch the actual layout/component definitions and implement the final structure with the design's CSS and markup.
|
|
33
|
-
|
|
34
|
-
## Creating Or Editing Designs
|
|
35
|
-
|
|
36
|
-
When the user asks to create a new design, use `starter` as the default base design unless they specify another base. Interview the user before saving anything: collect visual references such as images, webpages, brands, decks, or text descriptions, plus must-have and must-avoid constraints. Summarize the design brief and visual schema, then wait for the user to confirm before creating files.
|
|
37
|
-
|
|
38
|
-
After confirmation, read the base design with `revela_design_read`. Generate complete `DESIGN.md` and complete `preview.html` content, then call `revela_design_draft_create` to save a workspace-local draft under `.revela/drafts/designs/<name>/`. Always call `revela_design_draft_validate` after draft creation or overwrite. The direct registry tools `revela_design_create` and `revela_design_validate` remain available for existing workflows, but Codex design authoring should use the draft workflow before install.
|
|
39
|
-
|
|
40
|
-
Install the draft globally only after the user confirms the validated draft should be installed. Call `revela_design_draft_install` to copy the draft into the user-level design registry. If a user-level design already exists, pass `overwrite: true` only after the user confirms replacement. In sandboxed Codex sessions, the install step may require permission to write Revela user config under `~/.config/revela`.
|
|
41
|
-
|
|
42
|
-
`DESIGN.md` must include frontmatter with `name`, `description`, `author`, and `version`, plus valid marker blocks for `@design:foundation`, `@design:rules`, at least one `@layout`, and at least one `@component`.
|
|
43
|
-
|
|
44
|
-
`preview.html` must be self-contained and directly openable in a browser. Every `<section class="slide">` must include `slide-qa` and exactly one direct `.slide-canvas` child. Every direct `.slide-canvas` is the fixed 1920px x 1080px export surface and must use explicit CSS with `width: 1920px` and `height: 1080px`; `.slide` may remain a viewport/navigation wrapper. Include a cover slide with `data-slide-role="cover"`, a closing slide with `data-slide-role="closing"`, and a visible sample for every `@component:*` using `data-preview-component="<component-name>"`.
|
|
45
|
-
|
|
46
|
-
Do not automatically activate a newly created design. Do not automatically activate a newly installed design. Report the draft path, installed path when installed, and tell the user they can activate it with `revela_design_activate`.
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: revela-domain
|
|
3
|
-
description: Use or switch Revela domain guidance in Codex for init, research, and deck planning work.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Revela Domain
|
|
7
|
-
|
|
8
|
-
Use this skill when the user asks about Revela domains, wants domain-specific narrative guidance, asks to switch the active domain, or asks to create a new domain.
|
|
9
|
-
|
|
10
|
-
## Workflow
|
|
11
|
-
|
|
12
|
-
1. Call `revela_domain_list` to inspect installed domains and the active domain.
|
|
13
|
-
2. Call `revela_domain_read` for the active or requested domain.
|
|
14
|
-
3. When the user asks to switch domains for future narrative work, call `revela_domain_activate` with the requested domain name, then read the active domain again.
|
|
15
|
-
4. Use domain guidance for audience, decision, claim framing, objections, risks, and research-gap interpretation.
|
|
16
|
-
5. Do not treat domain guidance as evidence, source material, or proof for factual claims.
|
|
17
|
-
|
|
18
|
-
Domain changes are narrative-framing preferences. They do not rewrite existing claims, evidence boundaries, artifacts, or deck plans unless the user asks for those updates.
|
|
19
|
-
|
|
20
|
-
## Creating Or Editing Domains
|
|
21
|
-
|
|
22
|
-
When the user asks to create a new domain, interview the user before saving anything. Collect the communication context, typical audience, decisions, claim patterns, evidence expectations, common objections, risks, research-gap heuristics, terminology to use, and terminology to avoid. Summarize the domain brief, then wait for the user to confirm before creating files.
|
|
23
|
-
|
|
24
|
-
After confirmation, generate complete `INDUSTRY.md` content and call `revela_domain_draft_create` to save a workspace-local draft under `.revela/drafts/domains/<name>/`. Always call `revela_domain_draft_validate` after draft creation or overwrite.
|
|
25
|
-
|
|
26
|
-
Install the draft globally only after the user confirms the validated draft should be installed. Call `revela_domain_draft_install` to copy the draft into the user-level domain registry. If a user-level domain already exists, pass `overwrite: true` only after the user confirms replacement. In sandboxed Codex sessions, the install step may require permission to write Revela user config under `~/.config/revela`.
|
|
27
|
-
|
|
28
|
-
`INDUSTRY.md` must include frontmatter with `name`, `description`, `author`, and `version`, followed by concrete narrative guidance for audience framing, decision framing, claim standards, evidence expectations, objection/risk handling, and research-gap interpretation.
|
|
29
|
-
|
|
30
|
-
Do not automatically activate a newly installed domain. Report the draft path, installed path when installed, and tell the user they can activate it with `revela_domain_activate`.
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: revela-init
|
|
3
|
-
description: Initialize a Revela deck-first workspace in Codex from local source materials and material reviews.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Revela Init
|
|
7
|
-
|
|
8
|
-
Use this skill when the user asks to start Revela, initialize the workspace, ingest local materials, or prepare source inputs for a deck.
|
|
9
|
-
|
|
10
|
-
## Product Contract
|
|
11
|
-
|
|
12
|
-
- Init prepares local source material intake; it does not create a Narrative Vault.
|
|
13
|
-
- Durable deck-first state is local material intake, material review files, `researches/`, `deck-plan.md`, `assets/`, and `decks/*.html`.
|
|
14
|
-
- Scan results prove only that files exist. A material is usable only after its direct text or extracted read view has been reviewed.
|
|
15
|
-
- Do not invent quotes, source paths, URLs, page references, caveats, licenses, or artifact coverage.
|
|
16
|
-
|
|
17
|
-
## Workflow
|
|
18
|
-
|
|
19
|
-
1. Call `revela_prepare_local_materials` first. Treat the result as an intake registry and task list.
|
|
20
|
-
2. For Office/PDF sources, read `allowedReadPath` / `read_view_path`; if missing, call `revela_extract_document_materials`.
|
|
21
|
-
3. Prefer local source materials first: Markdown, text, CSV, PDFs, Office files, existing `researches/`, `deck-plan.md`, `assets/`, and `decks/`.
|
|
22
|
-
4. After reading extracted material views, call `revela_record_material_review` for each considered Office/PDF source.
|
|
23
|
-
5. Call `revela_check_material_intake` before the final report and surface scanned-but-unreviewed, unsupported, failed, or text-only limitations.
|
|
24
|
-
6. Ask only high-impact intent questions: audience, objective, decision/action, scope, language, source priority, or whether public research is allowed.
|
|
25
|
-
7. End with an intake report: local materials found, read views reviewed, material reviews recorded, source limitations, captured user intent, and next command.
|
|
26
|
-
|
|
27
|
-
## Report
|
|
28
|
-
|
|
29
|
-
- Recommend `/revela research` when public/source support is still needed.
|
|
30
|
-
- Recommend `/revela plan --deck` when enough local/research inputs exist.
|
|
31
|
-
- Do not ask for layout, visual style, output path, export format, or approval during init.
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: revela-upgrade
|
|
3
|
-
description: Guide Revela Codex plugin upgrade, update, version, and reinstall requests while checking the running runtime version first.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Revela Upgrade
|
|
7
|
-
|
|
8
|
-
Use this skill when the user asks how to upgrade, update, reinstall, or check the version of the Revela Codex plugin.
|
|
9
|
-
|
|
10
|
-
## Workflow
|
|
11
|
-
|
|
12
|
-
1. Call `revela_doctor` first to inspect the currently running Revela runtime version.
|
|
13
|
-
2. Report the current runtime version from doctor output. Do not check the latest version online unless the user explicitly asks you to look it up.
|
|
14
|
-
3. Explain that the Codex Git marketplace ref and `.mcp.json` npm runtime pin are published together for the same Revela release.
|
|
15
|
-
4. If the user wants a fixed release, guide them through removing the installed plugin, removing the marketplace entry, adding the desired release tag, then adding the plugin again:
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
codex plugin remove revela@revela
|
|
19
|
-
codex plugin marketplace remove revela
|
|
20
|
-
codex plugin marketplace add https://github.com/cyber-dash-tech/revela --ref vX.Y.Z
|
|
21
|
-
codex plugin add revela@revela
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
5. If the user already tracks a branch or movable ref, guide them through upgrading the marketplace clone, then re-adding the plugin:
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
codex plugin marketplace upgrade revela
|
|
28
|
-
codex plugin add revela@revela
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
6. Tell the user to start a new Codex thread after upgrading so Codex reloads the Revela skills, MCP tools, hooks, and runtime pin.
|
|
32
|
-
|
|
33
|
-
Do not run `codex plugin remove`, `codex plugin marketplace remove`, `codex plugin marketplace add`, `codex plugin marketplace upgrade`, or `codex plugin add` unless the user explicitly asks you to perform the upgrade or reinstall.
|