Skip to content

Commit 3063ad5

Browse files
Suraj1235Suraj1235
committed
docs: add evidence-led GTM surfaces
1 parent 011f41a commit 3063ad5

10 files changed

Lines changed: 394 additions & 5 deletions

File tree

‎.github/DISCUSSION_TEMPLATE/host-validation.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
title: "Host validation: "
2+
labels: ["host-validation"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Use this to report whether ODW works on your agentic coder. Evidence beats vibes.
8+
- type: input
9+
id: host
10+
attributes:
11+
label: Host and version
12+
placeholder: "OpenCode 1.2.27"
13+
validations:
14+
required: true
15+
- type: input
16+
id: commit
17+
attributes:
18+
label: ODW commit
19+
placeholder: "git rev-parse --short HEAD"
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: result
24+
attributes:
25+
label: Result
26+
description: Paste `npm run smoke:hosts -- --json`, `doctor`, or workflow output.
27+
render: shell
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: verdict
32+
attributes:
33+
label: What should maintainers know?
34+
placeholder: "What worked, what failed, what was confusing?"

‎.github/ISSUE_TEMPLATE/adapter_request.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Adapter request
2+
description: Request or improve support for another agentic coding host.
3+
title: "adapter: "
4+
labels: ["adapter"]
5+
body:
6+
- type: input
7+
id: host
8+
attributes:
9+
label: Host name
10+
placeholder: "Example: Windsurf, Aider, Continue"
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: integration_surface
15+
attributes:
16+
label: Integration surface
17+
description: Link to plugin, MCP, command, skill, extension, or scripting docs if available.
18+
placeholder: "Docs URL and short notes"
19+
validations:
20+
required: true
21+
- type: dropdown
22+
id: model_access
23+
attributes:
24+
label: Does the host expose a native model/tool API?
25+
options:
26+
- Yes
27+
- No
28+
- Not sure
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: proof
33+
attributes:
34+
label: Local proof or constraints
35+
description: Share what you tried and any relevant command output.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Bug report
2+
description: Report a reproducible ODW defect.
3+
title: "bug: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for testing ODW. Please include enough detail for maintainers to reproduce the failure locally.
10+
- type: input
11+
id: version
12+
attributes:
13+
label: Commit or version
14+
description: Paste `git rev-parse --short HEAD` or the release/tag you used.
15+
placeholder: "29bbf3a"
16+
validations:
17+
required: true
18+
- type: dropdown
19+
id: host
20+
attributes:
21+
label: Host
22+
options:
23+
- OpenCode
24+
- Codex
25+
- Cursor
26+
- Antigravity
27+
- VS Code
28+
- Zed/zcode
29+
- Gemini CLI
30+
- Kimi
31+
- Daemon only
32+
- Other
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: commands
37+
attributes:
38+
label: Commands run
39+
description: Include the exact commands and relevant output.
40+
render: shell
41+
placeholder: |
42+
npm ci
43+
npm test
44+
npm run smoke:hosts -- --json
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: expected
49+
attributes:
50+
label: Expected behavior
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: actual
55+
attributes:
56+
label: Actual behavior
57+
validations:
58+
required: true
59+
- type: textarea
60+
id: environment
61+
attributes:
62+
label: Environment
63+
description: OS, Node version, host version, model/provider path, and anything unusual.
64+
placeholder: "Windows 11, Node 22.17.0, OpenCode 1.2.27, Ollama local endpoint"
65+
validations:
66+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Host validation board
4+
url: https://github.com/Suraj1235/open-dynamic-workflows/discussions
5+
about: Share host reports, proof, failures, and setup notes.

‎.github/ISSUE_TEMPLATE/host_validation.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Host validation
2+
description: Share proof that ODW works or fails on an agentic coder.
3+
title: "host validation: "
4+
labels: ["host-validation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
ODW needs boring, reproducible host reports more than hype. Passing and failing results are both useful.
10+
- type: dropdown
11+
id: host
12+
attributes:
13+
label: Host
14+
options:
15+
- OpenCode
16+
- Codex
17+
- Cursor
18+
- Antigravity
19+
- VS Code
20+
- Zed/zcode
21+
- Gemini CLI
22+
- Kimi
23+
- Other
24+
validations:
25+
required: true
26+
- type: input
27+
id: host_version
28+
attributes:
29+
label: Host version
30+
placeholder: "opencode 1.2.27"
31+
validations:
32+
required: true
33+
- type: input
34+
id: odw_commit
35+
attributes:
36+
label: ODW commit
37+
placeholder: "git rev-parse --short HEAD"
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: smoke
42+
attributes:
43+
label: Smoke output
44+
description: Paste the relevant result from `npm run smoke:hosts -- --json`.
45+
render: json
46+
validations:
47+
required: true
48+
- type: dropdown
49+
id: model_path
50+
attributes:
51+
label: Model path tested
52+
options:
53+
- Host-native model
54+
- ODW daemon with provider key
55+
- ODW daemon with Ollama/local endpoint
56+
- MCP bridge only
57+
- Not sure
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: notes
62+
attributes:
63+
label: Notes
64+
description: Mention what worked, what failed, and whether a real workflow completed.

‎.github/ISSUE_TEMPLATE/install_failure.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Install failure
2+
description: Report a fresh clone/install problem.
3+
title: "install: "
4+
labels: ["install"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Fresh-install reports are high value. Please start from a clean clone when possible.
10+
- type: textarea
11+
id: commands
12+
attributes:
13+
label: Commands and output
14+
render: shell
15+
value: |
16+
git clone https://github.com/Suraj1235/open-dynamic-workflows.git
17+
cd open-dynamic-workflows
18+
npm ci
19+
validations:
20+
required: true
21+
- type: input
22+
id: node
23+
attributes:
24+
label: Node version
25+
placeholder: "node -v"
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: system
30+
attributes:
31+
label: System details
32+
placeholder: "OS, shell, architecture, package manager, corporate proxy if any"
33+
validations:
34+
required: true

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ Coverage is enforced at 80% lines on `core` and `daemon`.
3030
- `packages/daemon/schema.sql` and `packages/core/src/types.js` are the source of truth for the SQLite schema and the type contracts; `packages/daemon/src/server.js` defines the HTTP routes. Change the contract there first, then the implementation.
3131
- Don't add a dependency to the sandbox boundary without a very good reason, and pin it exactly if you do.
3232

33-
## How this repo was built
33+
## Where to start
3434

35-
This project was built with an autonomous, phase-gated engineering workflow. The shipped code is the map: start from `packages/core` (pure planning logic) and `packages/daemon/src` (the engine), and read `HANDOFF.md` for the operational picture.
35+
The shipped code is the map: start from `packages/core` (pure planning logic) and `packages/daemon/src` (the engine), and read `HANDOFF.md` for the operational picture.

‎HANDOFF.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,11 +200,11 @@ Good first tasks (from TECH_DEBT): add a `session.idle` progress push to the Ope
200200
- Design tokens: `design-system/MASTER.md`
201201
- External docs used: QuickJS-emscripten (github.com/justjake/quickjs-emscripten), `@opencode-ai/plugin` & SDK type definitions, Anthropic Messages API, OpenAI Chat Completions, Ollama API, GitHub REST repos API.
202202

203-
## 17. 🤖 Studio Prime Continuation
203+
## 17. 🤖 Phase-Gated Continuation
204204

205-
This project was built with Studio Prime, an autonomous phase-gated engineering workflow.
205+
This repo keeps archived phase-gated engineering notes for maintainers who want to continue the same style of careful implementation and adversarial review.
206206

207-
- **Resume:** run `claude` in this directory and say **"Continue Studio Prime"**. State lives in `.studio/` (outside the product repo, in the parent workspace).
207+
- **Resume:** use your preferred agentic coder in this directory and continue from the repo state plus the notes in this file. Historical phase state, when present, lives in `.studio/` outside the published product surface.
208208
- **Settings/hooks:** `.claude/settings.json` (workspace root) holds a PostToolUse audit hook; `.claude/settings.local.json` holds per-user permissions. Neither is required to develop ODW.
209209
- **Run an adversarial review manually:** dispatch the Task tool with `subagent_type: "general-purpose"` and the three-round (steelman → adversarial → synthesis) protocol, pointing it at the phase artifacts you want audited.
210210
- The phase verdicts live in `.studio/apex_red_team/reviews/phase[1-6]_verdict.{md,json}`.

‎docs/evidence/README.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# ODW Evidence Pack
2+
3+
ODW should earn attention with reproducible proof, not launch copy. This folder tracks the public evidence maintainers want before expanding claims in the README.
4+
5+
## Current Claim Boundaries
6+
7+
- **OpenCode:** strongest validated path. ODW can run through the daemon and has a host-native route when the host exposes model access.
8+
- **Codex:** plugin and MCP path are installable locally. Codex does not currently expose a documented host-native model API to third-party plugins, so full ODW runs use the local daemon/provider path.
9+
- **Cursor, Antigravity, VS Code, Zed/zcode, Gemini CLI, Kimi:** adapter paths exist, but each needs more external host validation before parity claims should be strengthened.
10+
- **Local-first mode:** daemon/provider mode supports local endpoints such as Ollama where configured.
11+
12+
## Proof Checklist
13+
14+
Run these from a fresh clone and paste notable output into issues or discussions:
15+
16+
```bash
17+
npm ci
18+
npm test
19+
npm run test:external
20+
npm run lint
21+
npm audit --audit-level=high
22+
npm run smoke:hosts -- --json
23+
npm run odw -- doctor all --json
24+
```
25+
26+
Host-specific proof is strongest when it includes:
27+
28+
- Host name and version.
29+
- ODW commit SHA.
30+
- OS and Node version.
31+
- Whether the model path was host-native, daemon with provider key, daemon with local/Ollama endpoint, or MCP bridge only.
32+
- A real workflow result, not only adapter discovery.
33+
34+
## Validation Matrix
35+
36+
| Host | Expected path | Evidence target | Status wording |
37+
| --- | --- | --- | --- |
38+
| OpenCode | Native host model where available, daemon fallback | 20-agent run, resume, smoke output | Proven strongest path when reproduced |
39+
| Codex | Codex plugin + MCP bridge + ODW daemon | plugin install, tool list, plan/run, doctor | Installable integration path |
40+
| Cursor | Rules/skill adapter + daemon | install, doctor, smoke, workflow | Needs external validation |
41+
| Antigravity | skill/workflow adapter + daemon | install, doctor, smoke, workflow | Needs external validation |
42+
| VS Code | extension/client + daemon | extension load, doctor, workflow | Needs external validation |
43+
| Zed/zcode | skill adapter + daemon | install, doctor, smoke, workflow | Needs external validation |
44+
| Gemini CLI | command adapter + daemon | install, doctor, smoke, workflow | Needs external validation |
45+
| Kimi | skill adapter + daemon | install, doctor, smoke, workflow | Needs external validation |
46+
47+
## Public CTA
48+
49+
When sharing ODW, keep the ask simple:
50+
51+
```text
52+
Star it if you want open ultracode. Try it on your coder. Paste one host result from `npm run smoke:hosts -- --json`.
53+
```

0 commit comments

Comments
 (0)