Skip to content

docs: clarify backend startup and first API test - #248

Merged
lopadova merged 2 commits into
mainfrom
task/docs/readme-zero-to-first-test
Sep 20, 2026
Merged

lopadova merged 2 commits into
mainfrom
task/docs/readme-zero-to-first-test

Conversation

@lopadova

Copy link
Copy Markdown
Contributor

Goal\nMake the README unambiguous for a junior who has never used AQA: start the application backend, start AQA's admin/backend, run the first test, and understand how to author a real scenario.\n\n## Changes\n- Two-process explanation with Terminal 1/Terminal 2 commands\n- Bundled Bun API absolute-beginner path\n- Concrete executable idempotency API scenario\n- Explicit risk-to-invariant-to-scenario linkage\n- Progress/lesson updates\n\n## Verification\n- README markdown link check passed\n- git diff --check passed\n- Commands compared against CLI and bundled example scripts\n\n## Review policy\nOperator has opted out of Copilot review for this side-project phase; all technical/documentation checks remain mandatory.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Deploying agentic-qa-kit with  Cloudflare Pages  Cloudflare Pages

Latest commit: b3bcab8
Status: ✅  Deploy successful!
Preview URL: https://6b2920ef.agentic-qa-kit.pages.dev
Branch Preview URL: https://task-docs-readme-zero-to-fir.agentic-qa-kit.pages.dev

View logs

@github-actions
github-actions Bot requested a lite review from Copilot September 20, 2026 18:49
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-20T18:53:34.113909Z d9b279b PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The documented setup and scenario flow has multiple unresolved moderate issues that prevent reliable execution and validation.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 4 Medium severity

Open (4)
What changed in this PR

Clarifies beginner onboarding for starting the application and AQA backends, running the first test, and authoring scenarios.

Changes:

  • Adds two-terminal startup instructions.
  • Documents the bundled Bun API walkthrough.
  • Adds an idempotency scenario and updates progress and lessons.
File Summary Final review findings
README.md Beginner setup, backend usage, and scenario guidance. 7 moderate findings: initialize/build from the correct directory and use the generated profile; configure sut.base_url; provide valid risk references; authenticate supported preconditions; add stronger duplicate-prevention assertions; fix heading structure. One nit concerns the walkthrough ordering.
docs/​PROGRESS.md Records onboarding progress. 1 nit: update the entry because the documented example flow currently fails before execution.
docs/​LESSON.md Captures onboarding lessons. No findings.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d9b279bd2f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
@github-actions
github-actions Bot requested a lite review from Copilot September 20, 2026 19:00
@lopadova
lopadova merged commit 9a8469f into main Sep 20, 2026
27 checks passed
@lopadova
lopadova deleted the task/docs/readme-zero-to-first-test branch September 20, 2026 19:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

README workflow and scenario issues currently prevent a reliable beginner setup and execution.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2 High severity · 5 Medium severity

Open (7)
Resolved since last review (4)
Previously missed (1)

In code that hasn't changed since last review

Low severity Place terminal block after initialization and base URL configuration

README.md:410

This block is placed before the walkthrough's aqa init step, so a junior following the documented order gets .aqa/project.yaml not found before any test runs. Also, init leaves sut.base_url unset unless the user configures it, which disables the HTTP driver. Make this terminal block explicitly follow initialization and base-URL configuration.

Comment thread README.md
Comment on lines +678 to +685
- id: o-first-created
kind: http_status
probe_id: probe-post-1
with: { expected: 201 }
- id: o-retry-replayed
kind: http_status
probe_id: probe-post-2
with: { expected: 200 }
Comment thread README.md
Comment on lines +686 to +689
- id: o-list-is-observable
kind: response_contains
probe_id: probe-list
with: { value: '"name":"x"' }
Comment thread README.md

# Work from the application directory: AQA resolves .aqa/ from process.cwd().
cd examples/bun-api
node ../../packages/kit/dist/cli.cjs init --overwrite
Comment thread README.md
Comment on lines +463 to +465
Open `http://127.0.0.1:5173`. For the complete automated journey, stop the
manual server and run `bun run e2e:ecosystem`; it starts the example target,
executes AQA and exercises the admin UI through Playwright.
Comment thread README.md
method: POST
url: "/items"
body: { name: "x" }
headers: { "Idempotency-Key": "junior-example-123" }
Comment thread README.md
Comment on lines +660 to +676
with:
method: POST
url: "/items"
body: { name: "x" }
headers: { "Idempotency-Key": "junior-example-123" }
- id: probe-post-2
kind: http
with:
method: POST
url: "/items"
body: { name: "x" }
headers: { "Idempotency-Key": "junior-example-123" }
- id: probe-list
kind: http
with:
method: GET
url: "/items?name=x"
Comment thread README.md
Comment on lines +710 to +711
`QA_TOKEN=... bunx aqa run --profile smoke` (PowerShell:
`$env:QA_TOKEN='...'; bunx aqa run --profile smoke`). A risk map entry without
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants