From a9cefb51a67a930800448af86f67eea9977c21af Mon Sep 17 00:00:00 2001 From: bigboateng Date: Sat, 8 Aug 2026 10:54:21 +0100 Subject: [PATCH] Clarify workflow create and convert prompts --- README.md | 10 ++++++++-- cmd/yskill/bootstrap.go | 4 +++- docs/agent-setup.md | 10 ++++++++-- docs/quickstart.md | 10 ++++++++-- evals/results/latest.json | 4 ++-- scripts/readme.test.mjs | 7 ++++++- sdk/python/README.md | 12 +++++++++++- sdk/rust/README.md | 12 +++++++++++- sdk/yield/README.md | 12 +++++++++++- 9 files changed, 68 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5cb2e17..b3debfb 100644 --- a/README.md +++ b/README.md @@ -58,10 +58,16 @@ Yield detects the repository, language, and installed coding agents. It shows every proposed file and dependency change. It asks before it writes. It then installs, tests, and registers the `yield-workflow-builder` skill workflow. -Restart your coding agent. Then ask: +Restart your coding agent. To create a new skill workflow, ask: ```text -Use Yield to turn my release skill into a tested workflow. +Use Yield to create a tested skill workflow for releasing my package. +``` + +To convert an existing `SKILL.md`, ask: + +```text +Use Yield to convert my existing release SKILL.md into a tested skill workflow. ``` The builder can create a skill workflow from a description. It can also diff --git a/cmd/yskill/bootstrap.go b/cmd/yskill/bootstrap.go index 6aadd0a..83c6d04 100644 --- a/cmd/yskill/bootstrap.go +++ b/cmd/yskill/bootstrap.go @@ -97,7 +97,9 @@ func cmdBootstrap(args []string) error { fmt.Printf("registered: %-22s %s\n", item.AgentID, item.Path) } fmt.Println("bootstrap: workflow builder is ready") - fmt.Println("next: restart your coding agent, then say: Use Yield to turn my release skill into a tested workflow.") + fmt.Println("next: restart your coding agent, then ask it to create or convert a skill workflow") + fmt.Println("create: Use Yield to create a tested skill workflow for releasing my package.") + fmt.Println("convert: Use Yield to convert my existing release SKILL.md into a tested skill workflow.") return nil } diff --git a/docs/agent-setup.md b/docs/agent-setup.md index c8099f9..8d5e0cb 100644 --- a/docs/agent-setup.md +++ b/docs/agent-setup.md @@ -89,10 +89,16 @@ go run github.com/operatorstack/yield/cmd/yskill@latest bootstrap --language go ``` Bootstrap shows every proposed change. Confirm the plan. Restart the coding -agent after registration. Then ask: +agent after registration. To create a new skill workflow, ask: ```text -Use Yield to turn my release skill into a tested workflow. +Use Yield to create a tested skill workflow for releasing my package. +``` + +To convert an existing `SKILL.md`, ask: + +```text +Use Yield to convert my existing release SKILL.md into a tested skill workflow. ``` The builder collects the specification, writes the skill workflow, runs its diff --git a/docs/quickstart.md b/docs/quickstart.md index b297b82..d796df1 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -41,10 +41,16 @@ the new adapter. ## 4. Ask for the skill workflow -Use a plain-language request: +To create a new skill workflow, ask: ```text -Use Yield to turn my release skill into a tested workflow. +Use Yield to create a tested skill workflow for releasing my package. +``` + +To convert an existing `SKILL.md`, ask: + +```text +Use Yield to convert my existing release SKILL.md into a tested skill workflow. ``` The builder can start from a description. It can also convert an existing diff --git a/evals/results/latest.json b/evals/results/latest.json index 9efc657..b3ba639 100644 --- a/evals/results/latest.json +++ b/evals/results/latest.json @@ -1,8 +1,8 @@ { "schema_version": 2, "methodology_version": "1.1", - "generated_at": "2026-08-08T09:46:54.610Z", - "source_digest": "e2d5965b634d1c9f5936988771bc62386cac97f5af9ce3119d2876390cff6a8d", + "generated_at": "2026-08-08T09:53:12.706Z", + "source_digest": "ec4d252c049a05e5031794ad7966587196e4749a209e4139916472401ec311c8", "status": "passed", "workflow_conformance": { "passed": 40, diff --git a/scripts/readme.test.mjs b/scripts/readme.test.mjs index c1d3f78..e56853c 100644 --- a/scripts/readme.test.mjs +++ b/scripts/readme.test.mjs @@ -296,7 +296,12 @@ test("README and quickstart use the public documentation and package registries" assert.ok(agentSetup.includes(command), `agent setup is missing ${command}`); } assert.doesNotMatch(quickstart, /get\.operatorstack\.systems\/npm|@operatorstack\/yield@0\./); - assert.match(quickstart, /Use Yield to turn my release skill into a tested workflow\./); + const createRequest = "Use Yield to create a tested skill workflow for releasing my package."; + const convertRequest = "Use Yield to convert my existing release SKILL.md into a tested skill workflow."; + for (const document of [readme, quickstart, agentSetup, pythonReadme, rustReadme, goReadme]) { + assert.ok(document.includes(createRequest), "agent-first documentation is missing the create request"); + assert.ok(document.includes(convertRequest), "agent-first documentation is missing the convert request"); + } assert.match(quickstart, /^## Advanced: build manually$/m); assert.match(agentSetup, /^## Run the registered skill$/m); }); diff --git a/sdk/python/README.md b/sdk/python/README.md index 3ed7659..3ac252b 100644 --- a/sdk/python/README.md +++ b/sdk/python/README.md @@ -36,7 +36,17 @@ uvx --from yieldskill yskill bootstrap --language python ``` Review and confirm the plan. Restart your coding agent. Then ask it to create -or convert a skill workflow. +a new skill workflow: + +```text +Use Yield to create a tested skill workflow for releasing my package. +``` + +To convert an existing `SKILL.md`, ask: + +```text +Use Yield to convert my existing release SKILL.md into a tested skill workflow. +``` ## Advanced: build manually diff --git a/sdk/rust/README.md b/sdk/rust/README.md index bc45dfc..f877c6c 100644 --- a/sdk/rust/README.md +++ b/sdk/rust/README.md @@ -38,7 +38,17 @@ yskill bootstrap --language rust ``` Review and confirm the plan. Restart your coding agent. Then ask it to create -or convert a skill workflow. +a new skill workflow: + +```text +Use Yield to create a tested skill workflow for releasing my package. +``` + +To convert an existing `SKILL.md`, ask: + +```text +Use Yield to convert my existing release SKILL.md into a tested skill workflow. +``` ## Advanced: build manually diff --git a/sdk/yield/README.md b/sdk/yield/README.md index e7ad389..46847aa 100644 --- a/sdk/yield/README.md +++ b/sdk/yield/README.md @@ -36,7 +36,17 @@ go run github.com/operatorstack/yield/cmd/yskill@latest bootstrap --language go ``` Review and confirm the plan. Restart your coding agent. Then ask it to create -or convert a skill workflow. +a new skill workflow: + +```text +Use Yield to create a tested skill workflow for releasing my package. +``` + +To convert an existing `SKILL.md`, ask: + +```text +Use Yield to convert my existing release SKILL.md into a tested skill workflow. +``` ## Advanced: build manually