waypoint-codex 0.19.2 → 1.0.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 +18 -37
- package/dist/src/cli.js +1 -1
- package/dist/src/core.js +33 -116
- package/dist/src/docs-index.js +1 -1
- package/dist/src/templates.js +0 -10
- package/package.json +1 -1
- package/templates/.agents/skills/agi-help/SKILL.md +1 -1
- package/templates/.agents/skills/code-guide-audit/SKILL.md +1 -5
- package/templates/.agents/skills/planning/SKILL.md +12 -10
- package/templates/.agents/skills/pr-review/SKILL.md +0 -1
- package/templates/.codex/agents/code-health-reviewer.toml +6 -5
- package/templates/.codex/agents/code-reviewer.toml +6 -5
- package/templates/.codex/agents/plan-reviewer.toml +6 -5
- package/templates/.waypoint/ACTIVE_PLANS.md +7 -7
- package/templates/.waypoint/README.md +5 -8
- package/templates/.waypoint/config.toml +0 -5
- package/templates/.waypoint/docs/README.md +1 -3
- package/templates/.waypoint/scripts/build-docs-index.mjs +25 -11
- package/templates/.waypoint/scripts/prepare-context.mjs +120 -205
- package/templates/WORKSPACE.md +2 -6
- package/templates/managed-agents-block.md +22 -111
- package/dist/src/track-index.js +0 -107
- package/templates/.agents/skills/break-it-qa/SKILL.md +0 -184
- package/templates/.agents/skills/break-it-qa/agents/openai.yaml +0 -4
- package/templates/.agents/skills/conversation-retrospective/SKILL.md +0 -147
- package/templates/.agents/skills/conversation-retrospective/agents/openai.yaml +0 -4
- package/templates/.agents/skills/docs-sync/SKILL.md +0 -78
- package/templates/.agents/skills/docs-sync/agents/openai.yaml +0 -4
- package/templates/.agents/skills/merge-ready-owner/SKILL.md +0 -196
- package/templates/.agents/skills/merge-ready-owner/agents/openai.yaml +0 -4
- package/templates/.agents/skills/pre-pr-hygiene/SKILL.md +0 -83
- package/templates/.agents/skills/pre-pr-hygiene/agents/openai.yaml +0 -4
- package/templates/.agents/skills/work-tracker/SKILL.md +0 -139
- package/templates/.agents/skills/work-tracker/agents/openai.yaml +0 -4
- package/templates/.agents/skills/workspace-compress/SKILL.md +0 -113
- package/templates/.agents/skills/workspace-compress/agents/openai.yaml +0 -4
- package/templates/.waypoint/SOUL.md +0 -71
- package/templates/.waypoint/agent-operating-manual.md +0 -178
- package/templates/.waypoint/scripts/build-track-index.mjs +0 -169
- package/templates/.waypoint/track/README.md +0 -38
- package/templates/.waypoint/track/_template.md +0 -48
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: docs-sync
|
|
3
|
-
description: Audit routed docs against the actual codebase and shipped behavior. Use when the user asks to sync docs, when docs may be stale after implementation work, before pushing or opening a PR, when routes, contracts, config, commands, or shipped behavior changed, or when Codex should find missing, incorrect, outdated, or broken documentation and then update or flag the exact gaps. Do not use this for vendor-doc ingestion, repo-memory cleanup, or broad code review that is not specifically about docs drift.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Docs Sync
|
|
7
|
-
|
|
8
|
-
Use this skill to keep repo docs aligned with reality.
|
|
9
|
-
|
|
10
|
-
This is not a vendor-doc ingestion skill and not a workspace-cleanup skill. It owns one job: compare the codebase and shipped behavior against routed docs, then fix or flag the mismatches.
|
|
11
|
-
|
|
12
|
-
## When Not To Use This Skill
|
|
13
|
-
|
|
14
|
-
- Skip it for importing or summarizing upstream vendor docs. Link to the real source instead of copying it into the repo.
|
|
15
|
-
- Skip it for workspace compression or tracker cleanup. This skill is about docs drift, not handoff hygiene.
|
|
16
|
-
- Skip it for broad code review that is not specifically about docs-to-reality mismatches.
|
|
17
|
-
- Skip it when the user only wants a new durable plan or architecture note; use the planning or normal docs-writing flow in that case.
|
|
18
|
-
|
|
19
|
-
## Read First
|
|
20
|
-
|
|
21
|
-
Before auditing docs:
|
|
22
|
-
|
|
23
|
-
1. Read `.waypoint/SOUL.md`
|
|
24
|
-
2. Read `.waypoint/agent-operating-manual.md`
|
|
25
|
-
3. Read `.waypoint/WORKSPACE.md`
|
|
26
|
-
4. Read `.waypoint/context/MANIFEST.md`
|
|
27
|
-
5. Read every file listed in that manifest
|
|
28
|
-
6. Read the routed docs for the area under review
|
|
29
|
-
|
|
30
|
-
## Step 1: Compare Docs To Reality
|
|
31
|
-
|
|
32
|
-
Audit the real code, routes, contracts, config surfaces, and user-visible behavior against `.waypoint/docs/`.
|
|
33
|
-
|
|
34
|
-
Look for:
|
|
35
|
-
|
|
36
|
-
- missing docs for real shipped behavior
|
|
37
|
-
- stale docs that describe removed or changed behavior
|
|
38
|
-
- broken routing links or docs index gaps
|
|
39
|
-
- examples or commands that no longer work
|
|
40
|
-
- contract/schema/config docs that no longer match the code
|
|
41
|
-
- docs that still describe future work as if it is already shipped
|
|
42
|
-
|
|
43
|
-
## Step 2: Fix Or Flag
|
|
44
|
-
|
|
45
|
-
- Update the docs when the correct wording is clear.
|
|
46
|
-
- Add the smallest routed doc needed when behavior exists but is undocumented.
|
|
47
|
-
- Remove or reframe stale claims instead of letting them linger.
|
|
48
|
-
- If a mismatch is real but the correct doc shape is unclear, flag it explicitly instead of bluffing.
|
|
49
|
-
|
|
50
|
-
Do not mirror vendor reference docs into the repo. Link to the real upstream docs when that is the right source of truth.
|
|
51
|
-
|
|
52
|
-
## Step 3: Refresh Routing
|
|
53
|
-
|
|
54
|
-
After changing routed docs:
|
|
55
|
-
|
|
56
|
-
- Run `node .waypoint/scripts/prepare-context.mjs` so the docs index and generated context match the updated docs.
|
|
57
|
-
|
|
58
|
-
## Step 4: Report The Sync Result
|
|
59
|
-
|
|
60
|
-
Summarize:
|
|
61
|
-
|
|
62
|
-
- what docs were stale or missing
|
|
63
|
-
- what you updated
|
|
64
|
-
- what still needs a decision, if anything
|
|
65
|
-
|
|
66
|
-
## Gotchas
|
|
67
|
-
|
|
68
|
-
- Do not trust docs-to-docs consistency alone. The source of truth is the shipped code and behavior, not whether two markdown files agree with each other.
|
|
69
|
-
- Do not leave stale future-tense claims behind after a feature ships or is cut. Docs drift often shows up as roadmap language that quietly became false.
|
|
70
|
-
- Do not update prose without checking commands, routes, config names, and examples. Small copied snippets are often where docs rot first.
|
|
71
|
-
- Do not invent certainty when the right doc shape is unclear. Flag the mismatch instead of bluffing a final answer.
|
|
72
|
-
- After touching routed docs, always refresh the generated docs/context layer so the repo’s index and bootstrap bundle match the new reality.
|
|
73
|
-
|
|
74
|
-
## Keep This Skill Sharp
|
|
75
|
-
|
|
76
|
-
- After meaningful runs, add new gotchas when the same docs-drift pattern, broken example shape, or stale-claim mistake keeps recurring.
|
|
77
|
-
- Tighten the description if the skill misses real prompts like "sync the docs" or fires on requests that are really about repo-memory cleanup instead.
|
|
78
|
-
- If the skill starts needing detailed provider-specific or command-heavy guidance, move that detail into references instead of bloating the hub file.
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
interface:
|
|
2
|
-
display_name: "Docs Sync"
|
|
3
|
-
short_description: "Audit docs against the real codebase"
|
|
4
|
-
default_prompt: "Use $docs-sync to audit routed docs against the actual codebase and shipped behavior, then update or flag any missing, incorrect, or outdated documentation."
|
|
@@ -1,196 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: merge-ready-owner
|
|
3
|
-
description: Own a non-trivial change from approved plan through implementation, verification, PR creation or update, review handling, and merge-ready handoff. Use when the user wants Codex to take full ownership after the problem and plan are agreed, keep going without repeated check-ins, and return only when there is a clean PR ready to merge or a concrete blocker that cannot be cleared alone.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Merge Ready Owner
|
|
7
|
-
|
|
8
|
-
Use this skill when the user wants one continuous ownership loop instead of a handoff after coding.
|
|
9
|
-
|
|
10
|
-
The job is not "write some code." The job is "carry the agreed work all the way to a merge-ready PR or a clearly explained blocker."
|
|
11
|
-
|
|
12
|
-
## When Not To Use This Skill
|
|
13
|
-
|
|
14
|
-
- Skip it when the problem is still being shaped or the plan is not actually approved. Use `planning` first.
|
|
15
|
-
- Skip it for tiny local edits that do not justify a full ship loop.
|
|
16
|
-
- Skip it when the user explicitly wants to stay in the loop for each step instead of delegating the closeout.
|
|
17
|
-
|
|
18
|
-
## Finish Line
|
|
19
|
-
|
|
20
|
-
Before starting, treat this as the default definition of done:
|
|
21
|
-
|
|
22
|
-
- the agreed scope is implemented
|
|
23
|
-
- the work is based on the repo's current default branch state
|
|
24
|
-
- the right PR exists and is up to date when the repo uses PRs
|
|
25
|
-
- the relevant tests, typechecks, lint, builds, or smoke checks for the touched surface are green
|
|
26
|
-
- real verification has been done against the risky user or runtime path when practical
|
|
27
|
-
- docs, trackers, and workspace state are updated when the shipped behavior changed materially
|
|
28
|
-
- review comments are answered and meaningful findings are fixed
|
|
29
|
-
- CI is green when the repo uses CI
|
|
30
|
-
- the PR is merge-ready, or there is a concrete blocker that cannot be cleared alone
|
|
31
|
-
|
|
32
|
-
When the product surface makes it practical, extend done to include:
|
|
33
|
-
|
|
34
|
-
- a short recorded walkthrough of the verified final browser or app flow
|
|
35
|
-
- the local path to that recording
|
|
36
|
-
|
|
37
|
-
Do not stop at "the code compiles" or "the first push is up."
|
|
38
|
-
|
|
39
|
-
During the loop, keep live execution state current:
|
|
40
|
-
|
|
41
|
-
- update `WORKSPACE.md` as milestones, blockers, verification state, and next steps change
|
|
42
|
-
- if a tracker exists or the work has become tracker-worthy, update the tracker during the work instead of reconstructing it later
|
|
43
|
-
|
|
44
|
-
## Step 1: Reconfirm The Scope And Ownership Mode
|
|
45
|
-
|
|
46
|
-
- Make sure the plan is already approved or the user explicitly said to proceed.
|
|
47
|
-
- Restate the finish line to yourself before editing.
|
|
48
|
-
- Identify the highest-risk parts of the change so verification matches the real failure surface.
|
|
49
|
-
|
|
50
|
-
If the plan is not actually settled, stop and use `planning` instead of guessing.
|
|
51
|
-
|
|
52
|
-
## Step 2: Start From Fresh Branch State
|
|
53
|
-
|
|
54
|
-
- Sync with the repo's current default branch and base the work on that fresh state.
|
|
55
|
-
- If there is no branch yet, create one from the refreshed default branch.
|
|
56
|
-
- If there is already a PR, confirm it is still open before pushing more commits.
|
|
57
|
-
- If an old PR was closed or merged, create a fresh branch from the current default branch, carry forward only the needed work, and open a new PR if the repo uses PRs.
|
|
58
|
-
|
|
59
|
-
## Step 3: Implement In Small Verified Chunks
|
|
60
|
-
|
|
61
|
-
- Make the change in small logical chunks inside the current approved plan phase.
|
|
62
|
-
- Batch related edits into a meaningful phase slice before running heavyweight checks, reviewer passes, or a commit.
|
|
63
|
-
- Commit at phase boundaries or other meaningful checkpoints when the repo workflow benefits from granular history.
|
|
64
|
-
- Keep unrelated local changes intact.
|
|
65
|
-
- Do not stop after the first implementation pass if clear follow-up fixes are still needed.
|
|
66
|
-
|
|
67
|
-
For bugs, prefer reproducing the problem first, then fixing it, then proving the fix.
|
|
68
|
-
|
|
69
|
-
## Step 4: Use The Right Repo-Local Helpers
|
|
70
|
-
|
|
71
|
-
Use the repo's existing skills and reviewer agents instead of inventing a parallel process.
|
|
72
|
-
|
|
73
|
-
- Use `work-tracker` early when the work becomes non-trivial, multi-step, review-heavy, or checklist-driven enough that `WORKSPACE.md` alone will stop being a good live record.
|
|
74
|
-
- Use `docs-sync` when shipped behavior, routes, contracts, or commands changed materially.
|
|
75
|
-
- Use `pre-pr-hygiene` before pushing or opening/updating a PR when the change surface is substantial.
|
|
76
|
-
- Use `pr-review` once active PR review or automated review has started.
|
|
77
|
-
- Use `break-it-qa` for extra abuse testing on risky interactive flows when that pass is worth the time.
|
|
78
|
-
|
|
79
|
-
If the repo ships reviewer agents under `.codex/agents/`, use them in the closeout flow when they are available:
|
|
80
|
-
|
|
81
|
-
- run `code-reviewer` for every non-trivial completed phase before declaring the work clear
|
|
82
|
-
- run `code-health-reviewer` when the change is medium or large, especially when it adds structure, duplicates logic, or introduces new abstractions
|
|
83
|
-
- launch them in parallel when both apply
|
|
84
|
-
- use them at phase checkpoints, not only at the very end: after completing a substantial phase, before opening or materially updating a PR, after fixing substantial findings, and before final closeout
|
|
85
|
-
- treat them as fresh closeout passes, not as optional decoration
|
|
86
|
-
- if either reviewer finds anything more serious than obvious optional polish, fix those findings, rerun the most relevant verification, and run fresh reviewer passes instead of trusting stale results
|
|
87
|
-
- keep iterating until the remaining reviewer feedback is only nitpicks or none
|
|
88
|
-
|
|
89
|
-
If those reviewer agents are not present in the repo, do the equivalent closeout thinking locally and continue instead of blocking on missing helpers.
|
|
90
|
-
|
|
91
|
-
## Step 5: Choose Verification That Matches The Real Risk
|
|
92
|
-
|
|
93
|
-
- Discover and use the verification tools that already exist in the current project instead of assuming one fixed stack.
|
|
94
|
-
- For browser-facing work, use the available browser QA tooling and exercise the real UI.
|
|
95
|
-
- For mobile or desktop app work, use the app or simulator tooling available in the repo and exercise the real flow.
|
|
96
|
-
- For backend work, hit the real route, worker, or runtime boundary when practical instead of trusting only unit tests.
|
|
97
|
-
- For environment-specific bugs, prefer the environment's logs, traces, payloads, or metrics over local guesswork.
|
|
98
|
-
|
|
99
|
-
If an existing repo-local skill clearly matches the verification surface, use it.
|
|
100
|
-
|
|
101
|
-
## Step 6: Run The Phase Checkpoint And Pre-Push Loop
|
|
102
|
-
|
|
103
|
-
At the end of each completed phase:
|
|
104
|
-
|
|
105
|
-
- run the required tests and typechecks for the touched package or service
|
|
106
|
-
- run builds, lint, migrations, or focused smoke tests when they are part of the real risk surface
|
|
107
|
-
- run the relevant reviewer-agent passes for non-trivial work
|
|
108
|
-
- fix failing checks and reviewer findings before moving to the next phase
|
|
109
|
-
- rerun the checkpoint until the current phase is clean
|
|
110
|
-
- update `WORKSPACE.md`, `.waypoint/ACTIVE_PLANS.md`, and any active tracker with the current verification state before moving on
|
|
111
|
-
|
|
112
|
-
Before pushing:
|
|
113
|
-
|
|
114
|
-
- make sure the latest completed phase checkpoint is still green
|
|
115
|
-
- for user-facing flows, do at least one realistic manual or UI-driven pass beyond pure unit coverage
|
|
116
|
-
|
|
117
|
-
Do not push a branch that still obviously fails its own touched-surface checks.
|
|
118
|
-
|
|
119
|
-
## Step 7: Open Or Update The PR Cleanly
|
|
120
|
-
|
|
121
|
-
When the repo uses PRs:
|
|
122
|
-
|
|
123
|
-
- open the PR if one does not exist
|
|
124
|
-
- keep the PR title and body focused on user value and capability, not implementation trivia
|
|
125
|
-
- keep the PR description concise
|
|
126
|
-
- request preview or staging environments when they are part of validation
|
|
127
|
-
|
|
128
|
-
If the repo does not use PRs, keep moving through the equivalent review and handoff workflow instead of forcing PR-shaped steps.
|
|
129
|
-
|
|
130
|
-
Before opening or materially updating the PR on non-trivial work, strongly prefer a fresh reviewer-agent pass when those agents are available.
|
|
131
|
-
|
|
132
|
-
## Step 8: Babysit The PR Instead Of Dropping It
|
|
133
|
-
|
|
134
|
-
When the repo uses PRs, CI, or preview environments:
|
|
135
|
-
|
|
136
|
-
- watch CI until it settles
|
|
137
|
-
- investigate red checks instead of treating them as someone else's problem
|
|
138
|
-
- if a preview, staging, or deployment environment is required for validation, follow it through until the environment is usable or a real external blocker is proven
|
|
139
|
-
- if the live preview or deployed environment is the real risk surface, verify it directly when helpful instead of waiting only on a bot summary
|
|
140
|
-
|
|
141
|
-
The ownership loop is still active while CI, preview, or rollout is in flight.
|
|
142
|
-
|
|
143
|
-
## Step 9: Close The Review Loop
|
|
144
|
-
|
|
145
|
-
Once review starts:
|
|
146
|
-
|
|
147
|
-
- use `pr-review`
|
|
148
|
-
- read every meaningful comment
|
|
149
|
-
- fix valid findings
|
|
150
|
-
- reply inline where the workflow supports inline reply
|
|
151
|
-
- rerun the relevant verification after review-driven fixes
|
|
152
|
-
- if the fixes were meaningful, run fresh reviewer-agent passes before you call the work clear when those agents are available
|
|
153
|
-
|
|
154
|
-
Do not leave comments unanswered just because the code changed.
|
|
155
|
-
|
|
156
|
-
## Step 10: Re-Test The Risky User Paths
|
|
157
|
-
|
|
158
|
-
- Re-run the happy path after fixes.
|
|
159
|
-
- Re-run the exact paths that were previously broken.
|
|
160
|
-
- For stateful flows, also probe nearby failure surfaces: repeat actions, bad input, stale state, back navigation, recovery, and environment toggles.
|
|
161
|
-
- Capture screenshots when using interactive UI tooling if the environment allows it.
|
|
162
|
-
|
|
163
|
-
Record the walkthrough only after the verified final state is stable. Do not record the first flaky pass and call that proof.
|
|
164
|
-
|
|
165
|
-
## Step 11: Hand Back A Merge-Ready Truthful State
|
|
166
|
-
|
|
167
|
-
Only close out when you can truthfully say one of these:
|
|
168
|
-
|
|
169
|
-
- the PR is ready to merge
|
|
170
|
-
- or there is a concrete blocker you cannot clear alone
|
|
171
|
-
|
|
172
|
-
The final handoff should say:
|
|
173
|
-
|
|
174
|
-
- what is now working for the user
|
|
175
|
-
- what verification actually ran
|
|
176
|
-
- the PR link when there is one
|
|
177
|
-
- any remaining blocker or caveat that still matters
|
|
178
|
-
|
|
179
|
-
Keep the handoff plain and direct. The point of this skill is to reduce the user's need to supervise the loop.
|
|
180
|
-
|
|
181
|
-
## Gotchas
|
|
182
|
-
|
|
183
|
-
- Do not mistake planning approval for permission to stop at implementation; this skill owns the full closeout.
|
|
184
|
-
- Do not let `WORKSPACE.md` or an active tracker fall behind reality while the work is in flight.
|
|
185
|
-
- Do not rely only on automated tests when the risky surface is interactive.
|
|
186
|
-
- Do not let stale previews, staging selectors, old PR branches, or half-deployed environments quietly poison verification.
|
|
187
|
-
- Do not treat CI failures, review comments, or rollout gates as outside the task once the user asked for full ownership.
|
|
188
|
-
- Do not declare success while known meaningful review findings or failing checks still exist.
|
|
189
|
-
- Do not confuse a reusable test harness or scripted UI test with the final walkthrough artifact; the artifact should show the real verified surface when practical.
|
|
190
|
-
- Do not forget the reviewer-agent loop when `code-reviewer` and `code-health-reviewer` are available. They are part of the closeout signal, not an afterthought, and serious findings should reopen the fix-and-review cycle.
|
|
191
|
-
|
|
192
|
-
## Keep This Skill Sharp
|
|
193
|
-
|
|
194
|
-
- Add new gotchas when the same ownership failure mode repeats.
|
|
195
|
-
- Tighten the description if the skill fires too early before planning is settled.
|
|
196
|
-
- If the closeout loop keeps depending on the same helper skills, reviewer agents, or verification surfaces, encode that expectation here instead of rediscovering it in chat.
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
interface:
|
|
2
|
-
display_name: "Merge-Ready Owner"
|
|
3
|
-
short_description: "Own approved work through merge-ready closeout"
|
|
4
|
-
default_prompt: "Use $merge-ready-owner when the plan is already approved and you should carry the work all the way through implementation, verification, reviewer-agent passes, PR handling, and merge-ready handoff without repeated check-ins."
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: pre-pr-hygiene
|
|
3
|
-
description: Run a broad final hygiene pass before pushing, before opening or updating a PR, or after a large implementation chunk when the diff is substantial and needs a deeper audit than per-commit review. Verify code-guide compliance, docs-to-behavior alignment, shared contract/schema drift, typing gaps, optimistic UI rollback or invalidation strategy, persistence correctness risks, and any other cross-cutting quality issues that would make the next review painful.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Pre-PR Hygiene
|
|
7
|
-
|
|
8
|
-
Use this skill for the larger final audit before code leaves the machine.
|
|
9
|
-
|
|
10
|
-
## When Not To Use This Skill
|
|
11
|
-
|
|
12
|
-
- Skip it for tiny changes that do not justify a broad hygiene pass.
|
|
13
|
-
- Skip it after a PR already has active review comments; use `pr-review` for that loop.
|
|
14
|
-
- Skip it when the task is only a narrow coding-guide check or only a docs sync pass.
|
|
15
|
-
|
|
16
|
-
## Read First
|
|
17
|
-
|
|
18
|
-
Before the hygiene pass:
|
|
19
|
-
|
|
20
|
-
1. Read `.waypoint/SOUL.md`
|
|
21
|
-
2. Read `.waypoint/agent-operating-manual.md`
|
|
22
|
-
3. Read `.waypoint/WORKSPACE.md`
|
|
23
|
-
4. Read `.waypoint/context/MANIFEST.md`
|
|
24
|
-
5. Read every file listed in that manifest
|
|
25
|
-
6. Read the repo's routed code guide and the routed docs relevant to the area being shipped
|
|
26
|
-
|
|
27
|
-
In standard Waypoint repos, the code guide lives at `.waypoint/docs/code-guide.md`. If the repo routes it somewhere else, follow the repo's own docs and routing instead of assuming another fixed path.
|
|
28
|
-
|
|
29
|
-
## Step 1: Audit The Whole Change Surface
|
|
30
|
-
|
|
31
|
-
Inspect the code and docs that are about to ship.
|
|
32
|
-
|
|
33
|
-
Look for:
|
|
34
|
-
|
|
35
|
-
- code-guide violations such as silent fallbacks, swallowed errors, weak boundary validation, unsafe typing, or stale compatibility layers
|
|
36
|
-
- stale docs, stale routes, or workspace notes that no longer match real behavior
|
|
37
|
-
- shared schema, fixture, or API-contract drift
|
|
38
|
-
- typing gaps such as avoidable `any`, weak narrowing, or unnecessary casts
|
|
39
|
-
- optimistic UI without rollback or invalidation
|
|
40
|
-
- persistence risks such as missing provenance, missing idempotency protection, weak uniqueness, or missing foreign-key style invariants
|
|
41
|
-
|
|
42
|
-
Skip checks that truly do not apply, but say that you skipped them.
|
|
43
|
-
|
|
44
|
-
## Step 2: Fix Or Stage Findings
|
|
45
|
-
|
|
46
|
-
- Fix meaningful issues directly when the right remediation is clear.
|
|
47
|
-
- Update `.waypoint/docs/` when shipped behavior or routes changed.
|
|
48
|
-
- If the live handoff has become bloated or stale, use `workspace-compress`.
|
|
49
|
-
|
|
50
|
-
Do not stop at reporting obvious fixable issues.
|
|
51
|
-
|
|
52
|
-
## Step 3: Verify Before Ship
|
|
53
|
-
|
|
54
|
-
Run the most relevant verification for the area:
|
|
55
|
-
|
|
56
|
-
- tests
|
|
57
|
-
- typecheck
|
|
58
|
-
- lint
|
|
59
|
-
- build
|
|
60
|
-
- targeted manual QA
|
|
61
|
-
|
|
62
|
-
## Step 4: Report The Gate Result
|
|
63
|
-
|
|
64
|
-
Summarize:
|
|
65
|
-
|
|
66
|
-
- what you checked
|
|
67
|
-
- what you fixed
|
|
68
|
-
- what verification ran
|
|
69
|
-
- what residual risks remain, if any
|
|
70
|
-
|
|
71
|
-
## Gotchas
|
|
72
|
-
|
|
73
|
-
- Do not turn this into a whole-repo cleanup mission. Keep the pass tied to the change surface that is about to leave the machine.
|
|
74
|
-
- Do not stop at reporting obvious fixable issues if the correct remediation is clear.
|
|
75
|
-
- Do not call the pass complete without real verification that matches the risk of the change.
|
|
76
|
-
- Do not let docs, contracts, and code drift just because the implementation itself "works."
|
|
77
|
-
- Do not use this as a replacement for active PR review or the normal closeout loop.
|
|
78
|
-
|
|
79
|
-
## Keep This Skill Sharp
|
|
80
|
-
|
|
81
|
-
- Add new gotchas when the same hygiene blind spot, contract drift, or verification miss keeps recurring.
|
|
82
|
-
- Tighten the description if the skill fires on tiny edits or misses real prompts about "do a final pass before I push."
|
|
83
|
-
- If the same cross-cutting checks keep being rediscovered, encode them more explicitly here instead of relying on chat memory.
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
interface:
|
|
2
|
-
display_name: "Pre-PR Hygiene"
|
|
3
|
-
short_description: "Run the final cross-cutting ship audit"
|
|
4
|
-
default_prompt: "Use $pre-pr-hygiene before pushing or opening/updating a PR for substantial work to do a broader hygiene pass across code, docs, contracts, typing, UI rollback, persistence correctness, and code-guide compliance."
|
|
@@ -1,139 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: work-tracker
|
|
3
|
-
description: Create or maintain a durable tracker under `.waypoint/track/` for any non-trivial workstream that needs ongoing execution state. Use when work has multiple steps, meaningful verification, review follow-ups, milestone checkpoints, or any real chance that `WORKSPACE.md` alone will stop being enough as the work evolves.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Work Tracker
|
|
7
|
-
|
|
8
|
-
Use this skill when the work has enough moving parts that the next state should not live only in chat or in a few workspace bullets.
|
|
9
|
-
|
|
10
|
-
This skill owns the execution tracker layer:
|
|
11
|
-
|
|
12
|
-
- create or update `.waypoint/track/<slug>.md`
|
|
13
|
-
- keep `WORKSPACE.md` pointing at the active tracker
|
|
14
|
-
- move detailed checklists and progress into the tracker instead of bloating the workspace
|
|
15
|
-
|
|
16
|
-
## When Not To Use This Skill
|
|
17
|
-
|
|
18
|
-
- Skip it for small single-shot tasks that fit comfortably in `WORKSPACE.md`.
|
|
19
|
-
- Skip it when the work has already finished and does not need a durable execution log.
|
|
20
|
-
- Skip it when the real need is docs compression or docs sync rather than active execution tracking.
|
|
21
|
-
|
|
22
|
-
## Read First
|
|
23
|
-
|
|
24
|
-
Before tracking:
|
|
25
|
-
|
|
26
|
-
1. Read `.waypoint/SOUL.md`
|
|
27
|
-
2. Read `.waypoint/agent-operating-manual.md`
|
|
28
|
-
3. Read `.waypoint/WORKSPACE.md`
|
|
29
|
-
4. Read `.waypoint/ACTIVE_PLANS.md`
|
|
30
|
-
5. Read `.waypoint/context/MANIFEST.md`
|
|
31
|
-
6. Read every file listed in that manifest
|
|
32
|
-
7. Read `.waypoint/track/README.md`
|
|
33
|
-
|
|
34
|
-
## When A Tracker Is Required
|
|
35
|
-
|
|
36
|
-
Create or update a tracker when any of these are true:
|
|
37
|
-
|
|
38
|
-
- the work is non-trivial and will unfold across multiple meaningful steps
|
|
39
|
-
- the work will likely span multiple sessions
|
|
40
|
-
- there are many actionable items to implement
|
|
41
|
-
- an audit, QA pass, or review produced a remediation campaign
|
|
42
|
-
- verification requires a substantial checklist
|
|
43
|
-
- the work has milestone checkpoints, PR stages, or repeated fix-and-verify loops
|
|
44
|
-
- `WORKSPACE.md` would become noisy if it carried all the detail
|
|
45
|
-
|
|
46
|
-
When in doubt, prefer creating or updating the tracker for non-trivial work instead of hoping the workspace alone will stay enough.
|
|
47
|
-
Small, single-shot work does not need a tracker.
|
|
48
|
-
|
|
49
|
-
## Step 1: Choose The Tracker File
|
|
50
|
-
|
|
51
|
-
- Use `.waypoint/track/<kebab-case-slug>.md`.
|
|
52
|
-
- If a relevant tracker already exists, update it instead of creating a competing one.
|
|
53
|
-
- Keep one tracker per coherent workstream, not one tracker per tiny edit.
|
|
54
|
-
|
|
55
|
-
## Step 2: Set The Frontmatter
|
|
56
|
-
|
|
57
|
-
Trackers need:
|
|
58
|
-
|
|
59
|
-
```yaml
|
|
60
|
-
---
|
|
61
|
-
summary: One-line description
|
|
62
|
-
last_updated: "2026-03-13 11:38 PDT"
|
|
63
|
-
status: active
|
|
64
|
-
read_when:
|
|
65
|
-
- resuming this workstream
|
|
66
|
-
---
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
Valid statuses:
|
|
70
|
-
|
|
71
|
-
- `active`
|
|
72
|
-
- `blocked`
|
|
73
|
-
- `paused`
|
|
74
|
-
- `done`
|
|
75
|
-
- `archived`
|
|
76
|
-
|
|
77
|
-
Use `active` unless there is a clear reason not to.
|
|
78
|
-
|
|
79
|
-
## Step 3: Structure The Tracker
|
|
80
|
-
|
|
81
|
-
A good tracker usually includes:
|
|
82
|
-
|
|
83
|
-
- `Goal`
|
|
84
|
-
- `Source`
|
|
85
|
-
- `Current State`
|
|
86
|
-
- `Next`
|
|
87
|
-
- `Workstreams`
|
|
88
|
-
- `Phase Checkpoints`
|
|
89
|
-
- `Verification`
|
|
90
|
-
- `Decisions`
|
|
91
|
-
- `Notes`
|
|
92
|
-
|
|
93
|
-
Use `- [ ]` checkboxes when there are many concrete tasks to track. Use status-style entries when the work is better expressed as phase/state updates than as a task list. Use timestamped bullets for materially revised state.
|
|
94
|
-
|
|
95
|
-
## Step 4: Link It From The Workspace
|
|
96
|
-
|
|
97
|
-
Add or update a bullet under `## Active Trackers` in `.waypoint/WORKSPACE.md` that points at the tracker path and states the current phase or next step.
|
|
98
|
-
If the work is driven by an approved plan, keep `.waypoint/ACTIVE_PLANS.md` aligned with the same phase naming and checkpoint language.
|
|
99
|
-
|
|
100
|
-
`WORKSPACE.md` should answer "what matters right now?"
|
|
101
|
-
`.waypoint/ACTIVE_PLANS.md` should answer "what plan and phase must be followed right now?"
|
|
102
|
-
The tracker should answer "what exactly is happening across the whole workstream?"
|
|
103
|
-
|
|
104
|
-
## Step 5: Maintain It During Execution
|
|
105
|
-
|
|
106
|
-
- Update `last_updated` whenever you materially change the tracker.
|
|
107
|
-
- Keep task lists or status entries current instead of deleting history. Mark completed checkbox items as `- [x]`, and update status-style entries when the phase or state changes.
|
|
108
|
-
- Add blockers, new tasks, and verification status as the work evolves.
|
|
109
|
-
- Update the tracker during the work, not only at the end. If a milestone, blocker, review round, or verification result changed reality, the tracker should already reflect it.
|
|
110
|
-
- When the workstream finishes, set `status: done` or `status: archived`.
|
|
111
|
-
|
|
112
|
-
Do not let the tracker become fiction. It must match reality.
|
|
113
|
-
|
|
114
|
-
## Step 6: Distill Durable Knowledge
|
|
115
|
-
|
|
116
|
-
If the tracker reveals durable architecture, rollout, or debugging knowledge, move that durable knowledge into `.waypoint/docs/` and leave the tracker focused on execution state.
|
|
117
|
-
|
|
118
|
-
## Report
|
|
119
|
-
|
|
120
|
-
When you create or update a tracker, report:
|
|
121
|
-
|
|
122
|
-
- the tracker path
|
|
123
|
-
- the current status
|
|
124
|
-
- what `WORKSPACE.md` now points to
|
|
125
|
-
|
|
126
|
-
## Gotchas
|
|
127
|
-
|
|
128
|
-
- Do not create a new tracker if a relevant active tracker already exists for the same workstream.
|
|
129
|
-
- Do not wait until final handoff to start the tracker if the work has already become multi-step, review-heavy, or hard to summarize from memory.
|
|
130
|
-
- Do not let the tracker become fiction. Completed items, blockers, and verification state should match reality.
|
|
131
|
-
- Do not stuff durable architecture or debugging knowledge into the tracker if it belongs in `.waypoint/docs/`.
|
|
132
|
-
- Do not leave `WORKSPACE.md` carrying the full execution log after a tracker exists.
|
|
133
|
-
- Do not keep trackers "active" forever after the work is done; update the status.
|
|
134
|
-
|
|
135
|
-
## Keep This Skill Sharp
|
|
136
|
-
|
|
137
|
-
- Add new gotchas when the same tracker drift, duplicate-tracker pattern, or workspace-bloat problem keeps recurring.
|
|
138
|
-
- Tighten the description if the skill fires for tiny work that does not need a tracker or misses long-running remediation campaigns.
|
|
139
|
-
- If the tracker format keeps needing the same recurring section or checklist pattern, capture that reusable pattern in the skill instead of rediscovering it each time.
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
interface:
|
|
2
|
-
display_name: "Work Tracker"
|
|
3
|
-
short_description: "Create or maintain a durable tracker for a large workstream"
|
|
4
|
-
default_prompt: "Use $work-tracker to create or update a tracker under .waypoint/track/, keep WORKSPACE.md pointing to it, and move detailed execution state out of chat and into the repo."
|
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: workspace-compress
|
|
3
|
-
description: Compress and refresh the repository's live workspace handoff so `WORKSPACE.md` stays short, current, and useful to the next agent. Use after finishing a meaningful chunk of work, before stopping for the session, before asking for review, before opening or updating a PR, or whenever the workspace has started accumulating stale history, repeated status logs, or resolved context that should no longer stay in the live handoff. Keep the minimum current operational state, collapse old resolved entries, and move durable detail into existing routed docs instead of duplicating it in the workspace.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Workspace Compress
|
|
7
|
-
|
|
8
|
-
Keep `WORKSPACE.md` as a live handoff, not a project diary.
|
|
9
|
-
|
|
10
|
-
This skill is for compression, not for erasing context. Preserve what the next agent needs in the first few minutes of a resume, and push durable detail into the docs layer that already exists in the repo.
|
|
11
|
-
|
|
12
|
-
## When Not To Use This Skill
|
|
13
|
-
|
|
14
|
-
- Skip it when the workspace is still short, current, and easy to resume from.
|
|
15
|
-
- Skip it when the detail you want to remove is still active execution state that belongs in a tracker.
|
|
16
|
-
- Skip it when the real problem is stale docs rather than stale workspace history.
|
|
17
|
-
|
|
18
|
-
## Read First
|
|
19
|
-
|
|
20
|
-
Before compressing:
|
|
21
|
-
|
|
22
|
-
1. Read `.waypoint/SOUL.md`
|
|
23
|
-
2. Read `.waypoint/agent-operating-manual.md`
|
|
24
|
-
3. Read `.waypoint/WORKSPACE.md`
|
|
25
|
-
4. Read `.waypoint/context/MANIFEST.md`
|
|
26
|
-
5. Read every file listed in that manifest
|
|
27
|
-
6. Read the routed docs relevant to the active workspace sections
|
|
28
|
-
|
|
29
|
-
## Step 1: Build Context From Routing, Not From Git Diff
|
|
30
|
-
|
|
31
|
-
This skill must work even in a dirty tree or an arbitrary session state.
|
|
32
|
-
|
|
33
|
-
- Read the workspace file in full.
|
|
34
|
-
- Read `.waypoint/DOCS_INDEX.md` and the workspace's obvious routing pointers.
|
|
35
|
-
- Read the project or domain docs directly linked from the active sections you may compress.
|
|
36
|
-
- If the workspace references a progress, status, architecture, or release doc, treat that as the durable home for details before removing anything from the live handoff.
|
|
37
|
-
|
|
38
|
-
Do not rely on `git diff` as the primary signal for what matters.
|
|
39
|
-
|
|
40
|
-
## Step 2: Apply The Handoff Test
|
|
41
|
-
|
|
42
|
-
Ask one question:
|
|
43
|
-
|
|
44
|
-
**What does the next agent need in the first 10 minutes to resume effectively?**
|
|
45
|
-
|
|
46
|
-
Keep only the answer to that question in the workspace. Usually that means:
|
|
47
|
-
|
|
48
|
-
- active tracker pointers
|
|
49
|
-
- current focus
|
|
50
|
-
- latest verified state
|
|
51
|
-
- open blockers or risks
|
|
52
|
-
- immediate next steps
|
|
53
|
-
- only the last few meaningful timestamped updates
|
|
54
|
-
|
|
55
|
-
Usually remove or collapse:
|
|
56
|
-
|
|
57
|
-
- resolved implementation logs
|
|
58
|
-
- repeated status updates that say the same thing
|
|
59
|
-
- validation transcripts
|
|
60
|
-
- old milestone history
|
|
61
|
-
- duplicated durable documentation
|
|
62
|
-
- per-item implementation checklists that belong in `.waypoint/track/`
|
|
63
|
-
|
|
64
|
-
Compression is documentation quality, not data loss.
|
|
65
|
-
|
|
66
|
-
## Step 3: Compress Safely
|
|
67
|
-
|
|
68
|
-
When editing the workspace:
|
|
69
|
-
|
|
70
|
-
1. Preserve the active operational truth.
|
|
71
|
-
2. Collapse stale resolved bullets into one short summary when history still matters.
|
|
72
|
-
3. Remove entries that are already preserved elsewhere and no longer affect immediate execution.
|
|
73
|
-
4. Keep timestamp discipline for new or materially revised bullets.
|
|
74
|
-
5. Do not turn the workspace into an archive, changelog, or debug notebook.
|
|
75
|
-
|
|
76
|
-
If durable context is missing from `.waypoint/docs/`, add or refresh the smallest coherent routed doc before removing it from the workspace.
|
|
77
|
-
If execution detail is still active but too large for the workspace, move it into `.waypoint/track/` instead of deleting it.
|
|
78
|
-
|
|
79
|
-
## Step 4: Protect User-Owned State
|
|
80
|
-
|
|
81
|
-
- Never overwrite or revert unrelated user changes.
|
|
82
|
-
- If a workspace or doc already has in-flight edits you did not make, read carefully and work around them.
|
|
83
|
-
- Prefer surgical edits over broad rewrites.
|
|
84
|
-
- Do not delete project memory just because live state is being compressed.
|
|
85
|
-
|
|
86
|
-
## Step 5: Refresh Routing
|
|
87
|
-
|
|
88
|
-
After changing routed docs or the workspace:
|
|
89
|
-
|
|
90
|
-
- Run `node .waypoint/scripts/prepare-context.mjs` so the docs index and generated context match the edited sources.
|
|
91
|
-
|
|
92
|
-
## Step 6: Report The Result
|
|
93
|
-
|
|
94
|
-
Summarize:
|
|
95
|
-
|
|
96
|
-
- what stayed in the live handoff
|
|
97
|
-
- what was collapsed or removed
|
|
98
|
-
- which durable docs now hold the preserved detail
|
|
99
|
-
- any remaining risk that still belongs in the workspace
|
|
100
|
-
|
|
101
|
-
## Gotchas
|
|
102
|
-
|
|
103
|
-
- Do not compress away the active operational truth just because the workspace feels long.
|
|
104
|
-
- Do not rely on `git diff` to decide what matters; the workspace must stay useful even in a dirty tree.
|
|
105
|
-
- Do not delete detail unless you know which routed doc or tracker now preserves it.
|
|
106
|
-
- Do not compress unresolved blockers or immediate next steps into vague summaries.
|
|
107
|
-
- Do not rewrite over in-flight user edits in the workspace or linked docs.
|
|
108
|
-
|
|
109
|
-
## Keep This Skill Sharp
|
|
110
|
-
|
|
111
|
-
- Add new gotchas when the same compression mistake, lost-context problem, or stale-workspace pattern keeps recurring.
|
|
112
|
-
- Tighten the description if the skill fires on already-clean workspaces or misses real "clean up the handoff" requests.
|
|
113
|
-
- If the same compression pattern keeps moving detail into the same durable home, make that routing more explicit in the skill.
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
interface:
|
|
2
|
-
display_name: "Workspace Compress"
|
|
3
|
-
short_description: "Compress the live workspace handoff"
|
|
4
|
-
default_prompt: "Use $workspace-compress after a meaningful chunk of work, before stopping, before review, or before opening or updating a PR to keep WORKSPACE.md short, current, and useful to the next agent."
|