waypoint-codex 0.10.4 → 0.10.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/dist/src/core.js CHANGED
@@ -382,6 +382,7 @@ export function doctorRepository(projectRoot) {
382
382
  "work-tracker",
383
383
  "docs-sync",
384
384
  "code-guide-audit",
385
+ "visual-explanations",
385
386
  "break-it-qa",
386
387
  "conversation-retrospective",
387
388
  "workspace-compress",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "waypoint-codex",
3
- "version": "0.10.4",
3
+ "version": "0.10.6",
4
4
  "description": "Codex-native repository operating system: scaffolding, docs routing, repo-local skills, doctor, and sync.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -0,0 +1,86 @@
1
+ ---
2
+ name: visual-explanations
3
+ description: Create generated images or annotated screenshots when a visual artifact would explain a concept, design, flow, comparison, or observed UI state more clearly than prose alone. Use for concept cards, visual summaries, mockups, labeled screenshots, timelines, comparisons, and other explanation-first visuals. Do not use this skill when a simple Mermaid diagram in chat is sufficient.
4
+ ---
5
+
6
+ # Visual Explanations
7
+
8
+ Use this skill when the explanation itself should become a visual artifact.
9
+
10
+ Mermaid does not need this skill. If a Mermaid diagram in chat is enough, use Mermaid directly and stop here.
11
+
12
+ ## Step 1: Pick The Right Visual
13
+
14
+ - Use Mermaid directly for flows, architecture, plans, state machines, and other text-native diagrams.
15
+ - Use an annotated screenshot when you need to explain a real UI state, call out a specific element, or show evidence from an actual screen.
16
+ - Use a generated image when Mermaid is too rigid and the explanation needs custom layout, stronger composition, a side-by-side comparison, a concept card, a rough mockup, or a more designed visual summary.
17
+
18
+ Do not make an image just because you can. Use the lightest visual that makes the explanation clearer.
19
+
20
+ ## Step 2: Define The Message First
21
+
22
+ Before drawing anything, write down:
23
+
24
+ - the one main point the visual should communicate
25
+ - which audience it is for
26
+ - whether it is evidence, explanation, or a conceptual sketch
27
+
28
+ One image should usually explain one idea.
29
+
30
+ ## Step 3: Gather Source Material
31
+
32
+ For annotated screenshots:
33
+
34
+ - capture the real UI state first
35
+ - keep the untouched source screenshot available until the annotated version is verified
36
+ - identify the exact element or area that the callout should reference
37
+
38
+ For generated images:
39
+
40
+ - list the minimum facts, labels, or comparison points that must appear
41
+ - sketch the rough composition in words before building it
42
+ - prefer using the repo's existing facts or screenshots over inventing fake details
43
+
44
+ If the image is conceptual rather than a faithful representation of current UI, label it clearly in the visual or in the accompanying text.
45
+
46
+ ## Step 4: Build With Simple, Deterministic Tools
47
+
48
+ Prefer straightforward local approaches:
49
+
50
+ - SVG for cards, timelines, comparisons, and lightweight custom layouts
51
+ - HTML/CSS rendered to an image when layout fidelity matters
52
+ - image-editing tools such as ImageMagick or Pillow for callouts, arrows, labels, crops, and overlays
53
+ - browser screenshots when the source needs to be a real page or app state
54
+
55
+ Do not over-engineer the rendering path. Favor the most reliable approach available in the current environment.
56
+
57
+ ## Step 5: Design For Clarity
58
+
59
+ - highlight the exact thing you are explaining
60
+ - keep callout text short
61
+ - use large, legible type
62
+ - use strong contrast
63
+ - leave enough whitespace so the image still scans quickly
64
+ - prefer one or two callouts over covering the image in labels
65
+ - crop or frame the relevant area when the full screen adds noise
66
+
67
+ Good visuals feel obvious at a glance.
68
+
69
+ ## Step 6: Verify The Output Yourself
70
+
71
+ Before sending the image:
72
+
73
+ - open or inspect the rendered result
74
+ - confirm it is not blank, clipped, washed out, or too tiny to read
75
+ - confirm arrows and labels point at the intended target
76
+ - confirm the image still makes sense without a long paragraph underneath it
77
+
78
+ Do not trust the generation step blindly.
79
+
80
+ ## Step 7: Deliver Cleanly
81
+
82
+ - show the image directly in chat
83
+ - add one to three sentences that explain what the user should notice
84
+ - prefer a single strong visual over a pile of mediocre ones
85
+
86
+ If the artifact is only for the current conversation, store it in a temp or scratch location. If the user wants a durable asset in the repo, place it in the repo's normal docs or asset structure instead of inventing a new convention.
@@ -0,0 +1,4 @@
1
+ interface:
2
+ display_name: "Visual Explanations"
3
+ short_description: "Create generated images and annotated screenshots"
4
+ default_prompt: "Use this skill to create a generated image or annotated screenshot when a visual artifact would explain the point more clearly than prose alone. Prefer Mermaid directly when a simple in-chat diagram is enough."
@@ -19,6 +19,7 @@ Find code that works but should be refactored. You're not looking for bugs (`cod
19
19
 
20
20
  Critical rules:
21
21
  You set the standard. Don't learn quality standards from existing code - the codebase may already be degraded. Apply good engineering judgment regardless of what exists.
22
+ - Read full files, not fragments.
22
23
 
23
24
  Explore what exists. Search for existing helpers, utilities, and patterns that could be reused instead of duplicated.
24
25
 
@@ -69,6 +70,10 @@ Focus on:
69
70
  - their imports
70
71
  - one level out when needed to validate a pattern
71
72
 
73
+ Review method:
74
+ - For each file you analyze, read the full file before forming a maintainability judgment.
75
+ - Use the diff or review slice to decide where to start, not as a substitute for file reading.
76
+
72
77
  Output:
73
78
  Return findings directly as structured text.
74
79
 
@@ -7,6 +7,7 @@
7
7
  .agents/skills/work-tracker/
8
8
  .agents/skills/docs-sync/
9
9
  .agents/skills/code-guide-audit/
10
+ .agents/skills/visual-explanations/
10
11
  .agents/skills/break-it-qa/
11
12
  .agents/skills/frontend-context-interview/
12
13
  .agents/skills/backend-context-interview/
@@ -57,6 +57,8 @@ If something important lives only in your head or in the chat transcript, the re
57
57
  - When browser work is part of reproduction or verification, send screenshots of the relevant UI states to the user so they can visually confirm what you observed.
58
58
  - Capture the states that matter, such as the broken state, the fixed state, or an important intermediate state that explains the issue.
59
59
  - If the current environment cannot provide screenshots, state that explicitly instead of silently omitting visual evidence.
60
+ - When an explanation would be clearer visually, prefer Mermaid diagrams directly in chat for flows, architecture, state, and plans instead of over-explaining in prose.
61
+ - Use `visual-explanations` when the explanation needs a richer generated image or an annotated screenshot rather than only text or Mermaid.
60
62
 
61
63
  ## Execution autonomy
62
64
 
@@ -95,6 +97,7 @@ Do not document every trivial implementation detail. Document the non-obvious, d
95
97
  - `work-tracker` when large multi-step work needs durable progress tracking in `.waypoint/track/`
96
98
  - `docs-sync` when routed docs may be stale, missing, or inconsistent with the codebase
97
99
  - `code-guide-audit` when a specific feature or file set needs a targeted coding-guide compliance check
100
+ - `visual-explanations` when a generated image or annotated screenshot would explain the work more clearly than prose alone; Mermaid diagrams do not need a skill
98
101
  - `conversation-retrospective` after major completed work pieces so the active conversation is distilled into durable memory, user feedback and errors are preserved, exercised skills are improved, and real new-skill candidates are recorded
99
102
  - `break-it-qa` when a browser-facing feature should be attacked with invalid inputs, refreshes, repeated clicks, wrong action order, or other adversarial manual QA
100
103
  - `frontend-ship-audit` and `backend-ship-audit` only when the user explicitly requests a ship-readiness audit; do not trigger them autonomously as part of the default Waypoint workflow
@@ -69,6 +69,7 @@ Prefer existing persisted context over re-interviewing the user.
69
69
  If the user approves a plan or explicitly tells you to proceed, treat that as authorization to execute the work end to end. Do not stop mid-implementation for incremental permission unless a real blocker, hidden-risk decision, or explicit user redirect requires a pause.
70
70
  When work is in flight elsewhere — reviewer agents, subagents, CI, automated review, external jobs, or other waiting periods — wait as long as required. There is no fixed waiting limit, and slowness alone is not a reason to interrupt or abandon the work.
71
71
  When using a browser to reproduce a bug, verify behavior, or confirm that a fix works, send the user screenshots of the relevant UI states so they can see the evidence directly. If screenshots are not possible in the current environment, say so explicitly.
72
+ When an explanation would be clearer as a visual than as prose, bias toward visual artifacts. Prefer Mermaid diagrams directly in chat for flows, architecture, state, and plans; use `visual-explanations` for richer generated images and for annotated screenshots that call out concrete UI states.
72
73
 
73
74
  Working rules:
74
75
  - Keep `.waypoint/WORKSPACE.md` current as the live execution state, with timestamped new or materially revised entries in multi-topic sections
@@ -78,6 +79,7 @@ Working rules:
78
79
  - Use `work-tracker` when a long-running implementation, remediation, or verification campaign needs durable progress tracking
79
80
  - Use `docs-sync` when the docs may be stale or a change altered shipped behavior, contracts, routes, or commands
80
81
  - Use `code-guide-audit` for a targeted coding-guide compliance pass on a specific feature, file set, or change slice
82
+ - Use `visual-explanations` when a generated image or annotated screenshot would explain the work more clearly than prose alone; Mermaid diagrams can be written directly in chat without invoking a skill
81
83
  - Use `conversation-retrospective` after major completed work pieces to preserve durable learnings, capture user feedback and errors, improve any skills that were exercised, and record real new-skill candidates
82
84
  - Do not invoke `break-it-qa`, `frontend-ship-audit`, or `backend-ship-audit` yourself from the managed AGENTS block workflow; they are user-facing skills for explicit human-requested QA or ship-readiness audits, not default agent steps
83
85
  - Before presenting a non-trivial implementation plan to the user, run `plan-reviewer` and iterate on the plan until it has no meaningful review findings left