waypoint-codex 0.10.3 → 0.10.5
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 +1 -1
- package/dist/src/core.js +1 -0
- package/package.json +1 -1
- package/templates/.agents/skills/pr-review/SKILL.md +5 -0
- package/templates/.agents/skills/visual-explanations/SKILL.md +86 -0
- package/templates/.agents/skills/visual-explanations/agents/openai.yaml +4 -0
- package/templates/.gitignore.snippet +1 -0
- package/templates/.waypoint/agent-operating-manual.md +4 -0
- package/templates/managed-agents-block.md +2 -0
package/README.md
CHANGED
|
@@ -161,7 +161,7 @@ The intended workflow is closeout-based: run `code-reviewer` before considering
|
|
|
161
161
|
|
|
162
162
|
For planning work, run `plan-reviewer` before presenting a non-trivial implementation plan to the user and iterate until it has no meaningful review findings left.
|
|
163
163
|
|
|
164
|
-
When the user approves a reviewed plan or explicitly says to proceed, the intended Waypoint behavior is autonomous execution: keep going through implementation, verification, review, and repo-memory updates unless a real blocker or materially risky unresolved decision requires a pause. If reviewers, subagents, CI, or other external work are still running, Waypoint should wait as long as necessary rather than interrupting them for speed.
|
|
164
|
+
When the user approves a reviewed plan or explicitly says to proceed, the intended Waypoint behavior is autonomous execution: keep going through implementation, verification, review, and repo-memory updates unless a real blocker or materially risky unresolved decision requires a pause. If reviewers, subagents, CI, or other external work are still running, Waypoint should wait as long as necessary rather than interrupting them for speed. For PR work, placeholder automated-review states like CodeRabbit's "review in progress" do not count as a completed review.
|
|
165
165
|
|
|
166
166
|
When browser-based reproduction or verification is part of the work, Waypoint should also send screenshots of the relevant UI states so the user can see the evidence directly.
|
|
167
167
|
|
package/dist/src/core.js
CHANGED
package/package.json
CHANGED
|
@@ -12,6 +12,9 @@ Use this skill to drive the PR through review instead of treating review as a on
|
|
|
12
12
|
- Check the PR's current review and CI status.
|
|
13
13
|
- If CI is red or pending, inspect the failed check logs before triaging review comments so you do not chase comment fixes while a separate blocker is breaking the branch.
|
|
14
14
|
- If automated review is still running, wait for it to finish instead of racing it.
|
|
15
|
+
- Treat placeholder messages such as CodeRabbit's "review in progress" as unfinished state, not as a meaningful review result.
|
|
16
|
+
- If an automated reviewer like CodeRabbit is still pending, in progress, or has not reached a green/completed check state yet, keep waiting before you conclude there are no findings.
|
|
17
|
+
- Once the automated reviewer check turns green/completed, reread the review comments and threads because the real findings may only appear after the placeholder state clears.
|
|
15
18
|
- If comments are still arriving, do not prematurely declare the loop complete.
|
|
16
19
|
- For stacked or non-`main` PRs, explicitly compare the PR head against its base branch and make sure later fixes on the base branch have actually been merged or rebased forward. Do not assume a sibling/base PR fix is already present in the dependent PR.
|
|
17
20
|
- Keep waiting as long as required. Do not interrupt or abandon the review loop just because CI, reviewers, or automated checks are taking a long time.
|
|
@@ -42,10 +45,12 @@ Do not leave comments unanswered.
|
|
|
42
45
|
- push follow-up commit(s)
|
|
43
46
|
- after pushing, return to the PR and wait for the next round of CI, automated review, and human review comments before deciding whether the loop is complete
|
|
44
47
|
- if CI or review is still in flight, keep waiting instead of assuming your last push ended the process
|
|
48
|
+
- before declaring the PR clear or ready, make sure the required Waypoint reviewer agents for this slice have actually run and that their real findings, if any, were handled
|
|
45
49
|
|
|
46
50
|
Stay in the loop until no new meaningful issues remain.
|
|
47
51
|
Never cut the loop short by forcing a partial return from still-running review or verification systems.
|
|
48
52
|
The loop is not complete while any meaningful review thread still lacks an inline response.
|
|
53
|
+
The loop is also not complete if required Waypoint reviewer-agent passes for the current slice have not been run yet.
|
|
49
54
|
|
|
50
55
|
## Step 5: Close With A Crisp State Summary
|
|
51
56
|
|
|
@@ -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."
|
|
@@ -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
|
|
@@ -132,6 +135,7 @@ Use reviewer agents before considering the work complete, not just as a reflex a
|
|
|
132
135
|
6. Do not call the work finished before you read the required reviewer results.
|
|
133
136
|
7. Wait for reviewer outputs even if that requires repeated or long waits. Do not interrupt them just because they are still running.
|
|
134
137
|
8. Fix real findings, rerun the relevant verification, update workspace/docs if needed, and make a follow-up commit when fixes change the repo.
|
|
138
|
+
9. Do not call a PR clear, ready, or done until the required reviewer-agent passes for the current slice have actually run.
|
|
135
139
|
|
|
136
140
|
## Quality bar
|
|
137
141
|
|
|
@@ -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
|