Skip to content

docs(cli): point skill references at absolute raw URLs #1557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Atchyut Preetham Pulavarthi (theonly1me) merged 1 commit into from
Sep 2, 2026
Merged

docs(cli): point skill references at absolute raw URLs #1557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/skill-reference-urls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@qawolf/cli": patch
---

Point the `qawolf-cli` skill's reference files at absolute raw URLs, so a harness that loads `SKILL.md` without its surrounding directory can still reach `references/runner.md` and `references/run-results.md`.
7 changes: 5 additions & 2 deletions skills/qawolf-cli/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ artifact URLs expire, its failure fields are absent from a passing run, and its
`traceUrl` downloads a Playwright trace that you can read as JSON without
opening the trace viewer. **Read
[`references/run-results.md`](references/run-results.md) before reporting on a
run's outcome or opening its trace.**
run's outcome or opening its trace.** If that path is not on your filesystem,
fetch it:
`https://raw.githubusercontent.com/qawolf/cli/main/skills/qawolf-cli/references/run-results.md`.

## Safety: reads vs writes

Expand Down Expand Up @@ -199,4 +201,5 @@ The full workflow is its own guide: how a runner is billed, why the first call
must be a run, the order the commands go in, the see-and-act loop, `exec`, the
recorder, reading history, staying alive, and an end-to-end example. **Read
[`references/runner.md`](references/runner.md) before driving a runner for the
first time.**
first time.** If that path is not on your filesystem, fetch it:
`https://raw.githubusercontent.com/qawolf/cli/main/skills/qawolf-cli/references/runner.md`.
7 changes: 5 additions & 2 deletions src/commands/qawolfCliSkill.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ artifact URLs expire, its failure fields are absent from a passing run, and its
`traceUrl` downloads a Playwright trace that you can read as JSON without
opening the trace viewer. **Read
[`references/run-results.md`](references/run-results.md) before reporting on a
run's outcome or opening its trace.**
run's outcome or opening its trace.** If that path is not on your filesystem,
fetch it:
`https://raw.githubusercontent.com/qawolf/cli/main/skills/qawolf-cli/references/run-results.md`.

## Safety: reads vs writes

Expand Down Expand Up @@ -141,4 +143,5 @@ The full workflow is its own guide: how a runner is billed, why the first call
must be a run, the order the commands go in, the see-and-act loop, `exec`, the
recorder, reading history, staying alive, and an end-to-end example. **Read
[`references/runner.md`](references/runner.md) before driving a runner for the
first time.**
first time.** If that path is not on your filesystem, fetch it:
`https://raw.githubusercontent.com/qawolf/cli/main/skills/qawolf-cli/references/runner.md`.
Loading