ci(docs): smoke start, troubleshoot, reference, and integration journeys - #5
ci(docs): smoke start, troubleshoot, reference, and integration journeys#5CompleteDotTech wants to merge 1 commit into
Conversation
Issue #778 asks for coven-docs pull-request CI and a browser smoke for the start, troubleshoot, reference, and integration routes. The PR CI lane (docs.yml: build, content/link/anchor validation, browser smoke) landed in OpenCoven#56; the smoke however covered no integration route at all. Extend scripts/smoke-docs.mjs so the browser smoke always exercises the four canonical journeys: - start: /docs/guide/getting-started (already covered, now tagged) - reference: /docs/reference/api (already covered, now tagged) - troubleshoot: /docs/reference/troubleshooting (already covered, now tagged) - integration: /docs/harnesses and /docs/harnesses/codex (new) The smoke now hard-fails if any required journey loses its routes, and records the journey -> route map in output/docs-smoke/report.json as CI evidence. Refs OpenCoven/coven#778 Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
|
CI verdict — unrelated, pre-existing failure; PR stays draft (no fake green) The The failure exists on current
Re-pinning the lock means re-verifying those contracts (and, for the automations work, their canonical pages). That reconciliation is already in flight in OpenCoven#77 for issue OpenCoven#75 ("docs-stale: upstream contract sources changed"), so this PR deliberately does not duplicate it. Meanwhile this branch's own behavior was validated locally: Once the OpenCoven#77 reconciliation lands, re-running this PR's checks should let the full verify — including the new journey smoke — execute end to end. |
Summary
Completes the browser-smoke coverage required by issue #778 for the four
canonical journey routes: start, troubleshoot, reference, and
integration.
docs.ymlruns onevery
pull_requestand executespnpm verify(build + content/link/anchorvalidation + browser smoke). It landed in refactor: certify and redesign the Coven documentation release surface OpenCoven/coven-docs#56, after #778 was filed — this PR
does not duplicate it.
change tags the existing start/reference/troubleshoot journey stops and adds
the missing integration stops:
/docs/harnessesand/docs/harnesses/codex(the Harnesses section is Coven's integration surface: built-in harness
adapters — codex, claude, coven-code, copilot).
scripts/smoke-docs.mjsnow hard-fails if any required journey loses itsroutes, and records the journey → route map in
output/docs-smoke/report.jsonas CI evidence (uploaded by
docs.ymlasdocs-certification-*artifacts).Slice note: this is the remaining slice of #778's "browser smoke for start,
troubleshoot, reference, and integration routes"; the PR CI (build + link
validation) part of #778 was already delivered by OpenCoven#56 and is unchanged here.
Source of truth
coven-docsPR CIbuilds, validates links, and browser-tests the primary journey").
content/docs/harnesses/index.mdx("Built-in harnesses") andcontent/docs/harnesses/codex.mdx("Coven launches it as a project-rootedPTY").
docs/site-manifest.json(harnesses:stable, ownerOpenCoven/coven), rendered throughcomponents/docs-status.tsx.Issue
Refs OpenCoven/coven#778
Closes OpenCoven/coven#778
Stability impact
Public surface
CI smoke coverage only; no routes, redirects, navigation, or visuals changed.
Test plan
pnpm typecheckpnpm check(content, site-manifest, link, anchor, automation checks +23 api-runner tests) — all green
pnpm build:sitefrom the working tree — build green (86 doc paths)HTTP 200, expected text, exactly one
h1/main, canonical link,data-docs-stability="stable", contract-source linkgit diff --checkpnpm verify(Chromium leg) — deferred to CI; thissandbox cannot run Chromium (no system X/Glib libraries, no root)