waypoint-codex 0.3.1 → 0.5.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 +2 -0
- package/dist/src/core.js +2 -0
- package/package.json +1 -1
- package/templates/.agents/skills/code-guide-audit/SKILL.md +65 -0
- package/templates/.agents/skills/code-guide-audit/agents/openai.yaml +4 -0
- package/templates/.agents/skills/docs-sync/SKILL.md +57 -0
- package/templates/.agents/skills/docs-sync/agents/openai.yaml +4 -0
- package/templates/.agents/skills/planning/SKILL.md +22 -17
- package/templates/.waypoint/agent-operating-manual.md +2 -0
- package/templates/managed-agents-block.md +2 -0
package/README.md
CHANGED
package/dist/src/core.js
CHANGED
package/package.json
CHANGED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-guide-audit
|
|
3
|
+
description: Audit a specific feature, file set, or implementation slice against the coding guide and report only coding-guide-related violations or risks in that scope. Use after building a feature, when the user wants a coding-guide compliance check, before review on a targeted area, or when validating whether a change follows rules like no silent fallbacks, strong boundary validation, frontend reuse, explicit state handling, and behavior-focused verification.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Code Guide Audit
|
|
7
|
+
|
|
8
|
+
Use this skill for a targeted audit against the coding guide, not for a whole-repo hygiene sweep.
|
|
9
|
+
|
|
10
|
+
This skill owns one job: inspect the specific code the user points at, map it against the coding guide, and report only guide-related findings in that scope.
|
|
11
|
+
|
|
12
|
+
## Step 1: Load The Right Scope
|
|
13
|
+
|
|
14
|
+
- Read `.waypoint/docs/code-guide.md`.
|
|
15
|
+
- Read only the files, routes, tests, contracts, and nearby docs needed to understand the specific feature or slice under review.
|
|
16
|
+
- If the scope is ambiguous, resolve it to a concrete file set, feature path, or commit-sized change surface before auditing.
|
|
17
|
+
|
|
18
|
+
Do not expand into a whole-repo audit unless the user explicitly asks for that.
|
|
19
|
+
|
|
20
|
+
## Step 2: Translate The Guide Into Checks
|
|
21
|
+
|
|
22
|
+
Audit only for rules that actually apply to the scoped code.
|
|
23
|
+
|
|
24
|
+
Look for:
|
|
25
|
+
|
|
26
|
+
- stale compatibility layers, shims, aliases, or migration-only branches
|
|
27
|
+
- weak typing, avoidable `any`, recreated shared types, or unsafe casts
|
|
28
|
+
- silent fallbacks, swallowed errors, degraded paths, or missing required-config failures
|
|
29
|
+
- missing validation at input, config, API, file, queue, or database boundaries
|
|
30
|
+
- speculative abstractions that hide the actual behavior
|
|
31
|
+
- unclear state transitions, weak transaction boundaries, missing idempotency, or weak persistence invariants
|
|
32
|
+
- frontend code that ignored reusable components or broke the existing design language
|
|
33
|
+
- missing loading, empty, or error states
|
|
34
|
+
- optimistic UI without rollback or invalidation
|
|
35
|
+
- missing observability at important failure or state boundaries
|
|
36
|
+
- regression tests that assert implementation details instead of behavior
|
|
37
|
+
|
|
38
|
+
Skip rules that genuinely do not apply, but say that you skipped them.
|
|
39
|
+
|
|
40
|
+
## Step 3: Keep The Audit Narrow
|
|
41
|
+
|
|
42
|
+
- Report only coding-guide findings for the requested scope.
|
|
43
|
+
- Do not drift into generic architecture advice, repo-wide cleanup, docs sync, or PR readiness unless the finding is directly required by the guide.
|
|
44
|
+
- If you notice issues outside scope, mention them only if they are severe enough that ignoring them would mislead the user about this audit.
|
|
45
|
+
|
|
46
|
+
This skill is narrower than `pre-pr-hygiene`. Use that other skill for broader ship-readiness.
|
|
47
|
+
|
|
48
|
+
## Step 4: Verify Evidence
|
|
49
|
+
|
|
50
|
+
Ground each finding in the actual code.
|
|
51
|
+
|
|
52
|
+
- Read the real implementation before calling something a violation.
|
|
53
|
+
- When relevant, inspect the nearest tests, contracts, schemas, or reused components to confirm the gap.
|
|
54
|
+
- Do not invent verification that you did not run.
|
|
55
|
+
|
|
56
|
+
If the user asked for a pure audit, stop at findings. If they asked for fixes too, fix the clear issues and then verify the changed area.
|
|
57
|
+
|
|
58
|
+
## Step 5: Report The Result
|
|
59
|
+
|
|
60
|
+
Summarize the scoped result in review style:
|
|
61
|
+
|
|
62
|
+
- findings first, ordered by severity
|
|
63
|
+
- each finding tied back to the relevant coding-guide rule
|
|
64
|
+
- include exact file references
|
|
65
|
+
- then note any skipped guide areas or residual uncertainty
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Code Guide Audit"
|
|
3
|
+
short_description: "Audit scoped code against the coding guide"
|
|
4
|
+
default_prompt: "Use this skill to audit a specific feature, file set, or implementation slice against the coding guide and report only guide-related violations or risks in that scope."
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs-sync
|
|
3
|
+
description: Audit routed docs against the actual codebase and shipped behavior. Use when docs may be stale after implementation work, before pushing or opening a PR, when routes/contracts/config changed, or when the agent should find missing, incorrect, outdated, or broken documentation and then update or flag the exact gaps.
|
|
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
|
+
## Read First
|
|
13
|
+
|
|
14
|
+
Before auditing docs:
|
|
15
|
+
|
|
16
|
+
1. Read `.waypoint/SOUL.md`
|
|
17
|
+
2. Read `.waypoint/agent-operating-manual.md`
|
|
18
|
+
3. Read `.waypoint/WORKSPACE.md`
|
|
19
|
+
4. Read `.waypoint/context/MANIFEST.md`
|
|
20
|
+
5. Read every file listed in that manifest
|
|
21
|
+
6. Read the routed docs for the area under review
|
|
22
|
+
|
|
23
|
+
## Step 1: Compare Docs To Reality
|
|
24
|
+
|
|
25
|
+
Audit the real code, routes, contracts, config surfaces, and user-visible behavior against `.waypoint/docs/`.
|
|
26
|
+
|
|
27
|
+
Look for:
|
|
28
|
+
|
|
29
|
+
- missing docs for real shipped behavior
|
|
30
|
+
- stale docs that describe removed or changed behavior
|
|
31
|
+
- broken routing links or docs index gaps
|
|
32
|
+
- examples or commands that no longer work
|
|
33
|
+
- contract/schema/config docs that no longer match the code
|
|
34
|
+
- docs that still describe future work as if it is already shipped
|
|
35
|
+
|
|
36
|
+
## Step 2: Fix Or Flag
|
|
37
|
+
|
|
38
|
+
- Update the docs when the correct wording is clear.
|
|
39
|
+
- Add the smallest routed doc needed when behavior exists but is undocumented.
|
|
40
|
+
- Remove or reframe stale claims instead of letting them linger.
|
|
41
|
+
- If a mismatch is real but the correct doc shape is unclear, flag it explicitly instead of bluffing.
|
|
42
|
+
|
|
43
|
+
Do not mirror vendor reference docs into the repo. Link to the real upstream docs when that is the right source of truth.
|
|
44
|
+
|
|
45
|
+
## Step 3: Refresh Routing
|
|
46
|
+
|
|
47
|
+
After changing routed docs:
|
|
48
|
+
|
|
49
|
+
- Run `node .waypoint/scripts/prepare-context.mjs` so the docs index and generated context match the updated docs.
|
|
50
|
+
|
|
51
|
+
## Step 4: Report The Sync Result
|
|
52
|
+
|
|
53
|
+
Summarize:
|
|
54
|
+
|
|
55
|
+
- what docs were stale or missing
|
|
56
|
+
- what you updated
|
|
57
|
+
- what still needs a decision, if anything
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Docs Sync"
|
|
3
|
+
short_description: "Audit docs against the real codebase"
|
|
4
|
+
default_prompt: "Use this skill to audit routed docs against the actual codebase and shipped behavior, then update or flag any missing, incorrect, or outdated documentation."
|
|
@@ -5,8 +5,8 @@ description: >
|
|
|
5
5
|
Use for new features, refactoring, architecture changes, migrations, or any non-trivial
|
|
6
6
|
implementation work. Ask multiple rounds of clarifying questions about product behavior,
|
|
7
7
|
user expectations, edge cases, and architecture; explore the repo deeply before deciding;
|
|
8
|
-
|
|
9
|
-
code or routed docs.
|
|
8
|
+
do not waste questions on implementation details that can be learned directly from the
|
|
9
|
+
code or routed docs; and write the final plan into `.waypoint/docs/` so it persists in the repo.
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Planning
|
|
@@ -26,20 +26,15 @@ Before planning:
|
|
|
26
26
|
5. Read every file listed in the manifest
|
|
27
27
|
6. Read the routed docs relevant to the task
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Output Location
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
The plan belongs in the repo, not only in chat.
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
### Clarifications
|
|
40
|
-
**Q:** [Your question]
|
|
41
|
-
**A:** [User's ENTIRE answer, verbatim]
|
|
42
|
-
```
|
|
33
|
+
- Write or update a durable plan doc under `.waypoint/docs/`.
|
|
34
|
+
- Choose the smallest routed location that matches the work, such as a project plan, implementation plan, or focused design note.
|
|
35
|
+
- If a relevant plan doc already exists, update it instead of creating a competing one.
|
|
36
|
+
- Make sure the doc remains discoverable through the routed docs layer.
|
|
37
|
+
- In chat, return only a concise summary plus the path to the plan doc.
|
|
43
38
|
|
|
44
39
|
## The Core Loop
|
|
45
40
|
|
|
@@ -105,6 +100,8 @@ Plans document your understanding. Include what matters for this task:
|
|
|
105
100
|
|
|
106
101
|
Use ASCII diagrams when they clarify flow, layering, or state.
|
|
107
102
|
|
|
103
|
+
Distill the requirements and clarifications into a clean plan document. Do not turn the plan into a transcript dump.
|
|
104
|
+
|
|
108
105
|
## Self-Review Before Finalizing
|
|
109
106
|
|
|
110
107
|
Before presenting the plan, verify against real code:
|
|
@@ -122,15 +119,15 @@ Before presenting the plan, verify against real code:
|
|
|
122
119
|
- No pretending you verified something you didn't
|
|
123
120
|
|
|
124
121
|
If the change touches durable project behavior, include docs/workspace updates in the plan.
|
|
125
|
-
|
|
122
|
+
Write or update the durable plan doc under `.waypoint/docs/` as part of the skill, not as an optional follow-up.
|
|
126
123
|
|
|
127
124
|
## External APIs
|
|
128
125
|
|
|
129
126
|
If an external API or library is relevant, read the actual upstream docs before finalizing the plan. Prefer the repo's external-doc links or URL registry when one exists. Read the real source docs; do not copy vendor reference material into the repo unless the user explicitly wants a durable local note.
|
|
130
127
|
|
|
131
|
-
##
|
|
128
|
+
## Plan Shape
|
|
132
129
|
|
|
133
|
-
A good
|
|
130
|
+
A good durable plan doc usually includes:
|
|
134
131
|
|
|
135
132
|
1. Current state
|
|
136
133
|
2. Proposed changes
|
|
@@ -139,6 +136,14 @@ A good final plan usually includes:
|
|
|
139
136
|
5. Verification
|
|
140
137
|
6. TL;DR
|
|
141
138
|
|
|
139
|
+
## Final Response
|
|
140
|
+
|
|
141
|
+
When the plan doc is written:
|
|
142
|
+
|
|
143
|
+
- give a short chat summary
|
|
144
|
+
- include the doc path
|
|
145
|
+
- call out any unresolved decisions that still need the user's input
|
|
146
|
+
|
|
142
147
|
## Quality Bar
|
|
143
148
|
|
|
144
149
|
If the plan would make the implementer ask "where does this hook in?" or "what exactly am I changing?", it is not done.
|
|
@@ -67,6 +67,8 @@ Do not document every trivial implementation detail. Document the non-obvious, d
|
|
|
67
67
|
- `error-audit` when failures are being swallowed or degraded invisibly
|
|
68
68
|
- `observability-audit` when production debugging signals look weak
|
|
69
69
|
- `ux-states-audit` when async/data-driven UI likely lacks loading, empty, or error states
|
|
70
|
+
- `docs-sync` when routed docs may be stale, missing, or inconsistent with the codebase
|
|
71
|
+
- `code-guide-audit` when a specific feature or file set needs a targeted coding-guide compliance check
|
|
70
72
|
- `workspace-compress` after meaningful chunks, before stopping, and before review when the live handoff needs compression
|
|
71
73
|
- `pre-pr-hygiene` before pushing or opening/updating a PR for substantial work
|
|
72
74
|
- `pr-review` once a PR has active review comments or automated review in progress
|
|
@@ -34,6 +34,8 @@ Working rules:
|
|
|
34
34
|
- Keep `.waypoint/WORKSPACE.md` current as the live execution state, with timestamped new or materially revised entries in multi-topic sections
|
|
35
35
|
- Update `.waypoint/docs/` when behavior or durable project knowledge changes, and refresh `last_updated` on touched routable docs
|
|
36
36
|
- Use the repo-local skills Waypoint ships for structured workflows when relevant
|
|
37
|
+
- Use `docs-sync` when the docs may be stale or a change altered shipped behavior, contracts, routes, or commands
|
|
38
|
+
- Use `code-guide-audit` for a targeted coding-guide compliance pass on a specific feature, file set, or change slice
|
|
37
39
|
- If optional reviewer roles are present and you make a commit, run `code-reviewer` and `code-health-reviewer` in parallel before calling the work done
|
|
38
40
|
- Before pushing or opening/updating a PR for substantial work, use `pre-pr-hygiene`
|
|
39
41
|
- Use `pr-review` once a PR has active review comments or automated review in progress
|