waypoint-codex 0.3.0 → 0.3.1
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 +0 -1
- package/package.json +1 -1
- package/templates/.agents/skills/planning/SKILL.md +18 -7
- package/templates/.codex/config.toml +0 -4
- package/templates/.waypoint/agent-operating-manual.md +0 -1
- package/templates/.codex/agents/docs-researcher.toml +0 -14
- package/templates/.waypoint/agents/docs-researcher.md +0 -73
package/README.md
CHANGED
|
@@ -70,7 +70,6 @@ If you initialize with `--with-roles`, Waypoint scaffolds:
|
|
|
70
70
|
|
|
71
71
|
- `code-health-reviewer`
|
|
72
72
|
- `code-reviewer`
|
|
73
|
-
- `docs-researcher`
|
|
74
73
|
- `plan-reviewer`
|
|
75
74
|
|
|
76
75
|
The intended workflow is post-commit: after your own commit lands, run `code-reviewer` and `code-health-reviewer` in parallel in the background, then fix real findings before you call the work finished.
|
package/package.json
CHANGED
|
@@ -3,9 +3,10 @@ name: planning
|
|
|
3
3
|
description: >
|
|
4
4
|
Interview-driven planning methodology that produces implementation-ready plans.
|
|
5
5
|
Use for new features, refactoring, architecture changes, migrations, or any non-trivial
|
|
6
|
-
implementation work. Ask multiple rounds of clarifying questions
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
implementation work. Ask multiple rounds of clarifying questions about product behavior,
|
|
7
|
+
user expectations, edge cases, and architecture; explore the repo deeply before deciding;
|
|
8
|
+
and do not waste questions on implementation details that can be learned directly from the
|
|
9
|
+
code or routed docs.
|
|
9
10
|
---
|
|
10
11
|
|
|
11
12
|
# Planning
|
|
@@ -20,7 +21,7 @@ Before planning:
|
|
|
20
21
|
|
|
21
22
|
1. Read `.waypoint/SOUL.md`
|
|
22
23
|
2. Read `.waypoint/agent-operating-manual.md`
|
|
23
|
-
3. Read
|
|
24
|
+
3. Read `.waypoint/WORKSPACE.md`
|
|
24
25
|
4. Read `.waypoint/context/MANIFEST.md`
|
|
25
26
|
5. Read every file listed in the manifest
|
|
26
27
|
6. Read the routed docs relevant to the task
|
|
@@ -55,7 +56,7 @@ Keep looping until you can explain:
|
|
|
55
56
|
|
|
56
57
|
## Interviewing
|
|
57
58
|
|
|
58
|
-
**Interviewing is the most important part of planning.** You cannot build what you don't understand. Every unasked question is an assumption that will break during implementation.
|
|
59
|
+
**Interviewing is the most important part of planning.** You cannot build what you don't understand. Every unasked product, behavior, edge-case, or architecture question is an assumption that will break during implementation.
|
|
59
60
|
|
|
60
61
|
Interview iteratively: 2-4 questions -> answers -> deeper follow-ups -> repeat. Each round should go deeper.
|
|
61
62
|
|
|
@@ -63,6 +64,16 @@ Interview iteratively: 2-4 questions -> answers -> deeper follow-ups -> repeat.
|
|
|
63
64
|
- Feature or migration -> many rounds of questions
|
|
64
65
|
- Architectural work -> keep drilling until the constraints and tradeoffs are clear
|
|
65
66
|
|
|
67
|
+
Ask aggressively about:
|
|
68
|
+
|
|
69
|
+
- how the feature should behave
|
|
70
|
+
- who the users are
|
|
71
|
+
- which edge cases matter
|
|
72
|
+
- what tradeoffs are acceptable
|
|
73
|
+
- what architecture direction the user wants
|
|
74
|
+
|
|
75
|
+
Do **not** spend those questions on implementation facts that can be learned from reading the code, routed docs, or external docs already linked by the repo.
|
|
76
|
+
|
|
66
77
|
Push back when something seems off. Neutrality is not the goal; correctness is.
|
|
67
78
|
|
|
68
79
|
## Exploring the Codebase
|
|
@@ -111,10 +122,11 @@ Before presenting the plan, verify against real code:
|
|
|
111
122
|
- No pretending you verified something you didn't
|
|
112
123
|
|
|
113
124
|
If the change touches durable project behavior, include docs/workspace updates in the plan.
|
|
125
|
+
If the plan is meant to outlive the current chat, write or update a durable plan doc under `.waypoint/docs/` and make sure it is discoverable through the routed docs layer.
|
|
114
126
|
|
|
115
127
|
## External APIs
|
|
116
128
|
|
|
117
|
-
If an external API or library is relevant
|
|
129
|
+
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.
|
|
118
130
|
|
|
119
131
|
## Output
|
|
120
132
|
|
|
@@ -130,4 +142,3 @@ A good final plan usually includes:
|
|
|
130
142
|
## Quality Bar
|
|
131
143
|
|
|
132
144
|
If the plan would make the implementer ask "where does this hook in?" or "what exactly am I changing?", it is not done.
|
|
133
|
-
|
|
@@ -13,10 +13,6 @@ config_file = "agents/code-health-reviewer.toml"
|
|
|
13
13
|
description = "Read-only background reviewer for post-commit bugs, regressions, and integration mistakes."
|
|
14
14
|
config_file = "agents/code-reviewer.toml"
|
|
15
15
|
|
|
16
|
-
[agents."docs-researcher"]
|
|
17
|
-
description = "Documentation researcher for external APIs, libraries, and tools when the repo lacks durable docs."
|
|
18
|
-
config_file = "agents/docs-researcher.toml"
|
|
19
|
-
|
|
20
16
|
[agents."plan-reviewer"]
|
|
21
17
|
description = "Read-only plan validator that checks whether a proposed implementation plan is complete, feasible, and safe to execute."
|
|
22
18
|
config_file = "agents/plan-reviewer.toml"
|
|
@@ -78,7 +78,6 @@ If the repo was initialized with Waypoint roles enabled, use them as focused sec
|
|
|
78
78
|
|
|
79
79
|
- `code-reviewer` for correctness and regression review
|
|
80
80
|
- `code-health-reviewer` for maintainability drift
|
|
81
|
-
- `docs-researcher` for external dependency research
|
|
82
81
|
- `plan-reviewer` to challenge weak implementation plans before execution
|
|
83
82
|
|
|
84
83
|
## Post-Commit Review Loop
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
model_reasoning_effort = "medium"
|
|
2
|
-
sandbox_mode = "read-only"
|
|
3
|
-
developer_instructions = """
|
|
4
|
-
Read these files in order before doing anything else:
|
|
5
|
-
1. .waypoint/SOUL.md
|
|
6
|
-
2. .waypoint/agent-operating-manual.md
|
|
7
|
-
3. WORKSPACE.md
|
|
8
|
-
4. .waypoint/context/MANIFEST.md
|
|
9
|
-
5. every file listed in that manifest
|
|
10
|
-
6. .waypoint/agents/docs-researcher.md
|
|
11
|
-
|
|
12
|
-
After reading them, follow .waypoint/agents/docs-researcher.md as your operating instructions.
|
|
13
|
-
"""
|
|
14
|
-
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: docs-researcher
|
|
3
|
-
source: meridian-adapted
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
You research external tools, APIs, and products, building comprehensive knowledge docs that the repo can reference later.
|
|
7
|
-
|
|
8
|
-
## Read First
|
|
9
|
-
|
|
10
|
-
1. Read `.waypoint/SOUL.md`
|
|
11
|
-
2. Read `.waypoint/agent-operating-manual.md`
|
|
12
|
-
3. Read `WORKSPACE.md`
|
|
13
|
-
4. Read `.waypoint/context/MANIFEST.md`
|
|
14
|
-
5. Read every file listed in the manifest
|
|
15
|
-
6. Read any existing repo docs for the dependency or integration
|
|
16
|
-
|
|
17
|
-
## Critical Rule
|
|
18
|
-
|
|
19
|
-
Do not write documentation from memory when the facts are version-sensitive.
|
|
20
|
-
|
|
21
|
-
Research first, then write.
|
|
22
|
-
|
|
23
|
-
## What You Produce
|
|
24
|
-
|
|
25
|
-
Not just API specs. Produce durable repo knowledge:
|
|
26
|
-
|
|
27
|
-
- what the tool is and what it's for
|
|
28
|
-
- current version or current relevant state
|
|
29
|
-
- setup requirements
|
|
30
|
-
- conceptual model
|
|
31
|
-
- best practices
|
|
32
|
-
- operations and constraints
|
|
33
|
-
- gotchas and known sharp edges
|
|
34
|
-
- links to official docs for deeper reading
|
|
35
|
-
|
|
36
|
-
## Process
|
|
37
|
-
|
|
38
|
-
### 1. Check Existing Docs
|
|
39
|
-
|
|
40
|
-
Search the repo for existing docs about the tool. Understand what's documented, what's missing, and what's stale.
|
|
41
|
-
|
|
42
|
-
### 2. Research
|
|
43
|
-
|
|
44
|
-
Use primary sources first:
|
|
45
|
-
|
|
46
|
-
- official docs
|
|
47
|
-
- official guides
|
|
48
|
-
- changelogs
|
|
49
|
-
- release notes
|
|
50
|
-
- authoritative repos
|
|
51
|
-
|
|
52
|
-
Capture text content, not just code snippets. The conceptual guides matter as much as the method signatures.
|
|
53
|
-
|
|
54
|
-
### 3. Write or Update Durable Docs
|
|
55
|
-
|
|
56
|
-
Create or update repo docs so future work does not have to repeat the same research.
|
|
57
|
-
|
|
58
|
-
### 4. Rebuild the Docs Index
|
|
59
|
-
|
|
60
|
-
If you add or update durable docs, rebuild `DOCS_INDEX.md`.
|
|
61
|
-
|
|
62
|
-
## Quality Bar
|
|
63
|
-
|
|
64
|
-
The repo should be smarter after you finish than before you started.
|
|
65
|
-
|
|
66
|
-
## Output
|
|
67
|
-
|
|
68
|
-
Summarize:
|
|
69
|
-
|
|
70
|
-
- what you researched
|
|
71
|
-
- what matters for this repo
|
|
72
|
-
- what durable docs were added or updated
|
|
73
|
-
|