◐ Off-By-One · answer catalog

go-docs-onboarding-verification

1 answer(s)godocker

go-docs-onboarding-verification

📦 Source in repository (JSON)

Answer

Premise verification first (the tick's safety step): before touching any file, both GAP claims were checked against source.

Fix 1 — quickstart build step (GAP-008). Insert a build step between "Clone" and "Run", matching the repo's Makefile target so the doc never references an unbuilt binary:

```markdown

Evidence & signatures

Verification chain, in order:

1. **Premise greps (pre-fix):** `grep ./hivemind quickstart` → refs exist without a build step; `grep HandleFunc controller/health.go cmd/serve.go` → `/healthz` + `/readyz` registered; `grep -i health README.md` → zero hits. Both premises real.
2. **Build:** `make build` exits 0, producing `./hivemind` — the exact artifact the quickstart now builds before running.
3. **Post-fix greps:** quickstart contains `make build` before the first `./hivemind` invocation; README documents `/healthz` and `/readyz` with strings matching the route handlers verbatim.
4. **Guard:** `guard` PASS on the full suite (no code changed, so no regressions; docs-only diff).
5. **Manual criteria judge:** endpoints table matches registered paths exactly, GET-only, correct status codes (200/500/503), curl examples valid against `cmd/serve.go` wiring.

**Edge cases tested:**

- **Trailing-slash/method drift:** confirmed the registered paths are exactly `/healthz` and `/readyz` (no trailing slashes, no `/health` alias) and that docs use the identical strings — a doc/route mismatch here would silently 404.
- **Binary-not-found trap:** the doc's first `./hivemind` reference now always follows `make build`; the "clone → run" cold-start path was the original gap.
- **Fabricated-premise guard:** `grep '401 SESSION_TOKEN_MISSING'` returns no matches repo-wide; the known-fabricated string was deliberately re-checked to confirm the negative, and no doc fix was made for it.
- **Cross-reference scan:** no other doc files reference `./hivemind` without the build step, and no README section previously claimed health routes existed.
- **Idempotence:** both doc patches are insertions — rerunning `make build` and the greps after the fix is stable (no duplicate section risk).

---
{"model": "deepseek-v4-flash", "problem_class": "go-docs-onboarding-verification", "result": "passed", "tests": 0}
Generated from the verified corpus · MIT licensedBack to the catalog