Skip to content

ci(docs): smoke start, troubleshoot, reference, and integration journeys - #80

Open
CompleteDotTech wants to merge 2 commits into
OpenCoven:mainfrom
CompleteDotTech:agent/issue-778-ci-docs-add-canonical-docs-build
Open

ci(docs): smoke start, troubleshoot, reference, and integration journeys#80
CompleteDotTech wants to merge 2 commits into
OpenCoven:mainfrom
CompleteDotTech:agent/issue-778-ci-docs-add-canonical-docs-build

Conversation

@CompleteDotTech

Copy link
Copy Markdown
Member

Summary

Completes the browser-smoke coverage required by issue #778 for the four
canonical journey routes: start, troubleshoot, reference, and
integration.

  • The coven-docs pull-request CI lane itself already exists: docs.yml runs on
    every pull_request and executes pnpm verify (build + content/link/anchor
    validation + browser smoke). It landed in refactor: certify and redesign the Coven documentation release surface #56, after #778 was filed — this PR
    does not duplicate it.
  • The existing smoke, however, covered no integration route at all. This
    change tags the existing start/reference/troubleshoot journey stops and adds
    the missing integration stops: /docs/harnesses and /docs/harnesses/codex
    (the Harnesses section is Coven's integration surface: built-in harness
    adapters — codex, claude, coven-code, copilot).
  • scripts/smoke-docs.mjs 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 (uploaded by docs.yml as docs-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 #56 and is unchanged here.

Source of truth

Issue

Refs OpenCoven/coven#778
Closes OpenCoven/coven#778

Stability impact

  • No product-contract change

Public surface

  • No public-surface change

CI smoke coverage only; no routes, redirects, navigation, or visuals changed.

Test plan

  • pnpm typecheck
  • pnpm check (content, site-manifest, link, anchor, automation checks +
    23 api-runner tests) — all green
  • pnpm build:site from the working tree — build green (86 doc paths)
  • SSR assertion pass against the built site for all five journey routes:
    HTTP 200, expected text, exactly one h1/main, canonical link,
    data-docs-stability="stable", contract-source link
  • git diff --check
  • Full browser smoke pnpm verify (Chromium leg) — deferred to CI; this
    sandbox cannot run Chromium (no system X/Glib libraries, no root)

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>
@vercel

vercel Bot commented Aug 30, 2026

Copy link
Copy Markdown

@CompleteDotTech is attempting to deploy a commit to the 0xBuns Team on Vercel.

A member of the Team first needs to authorize it.

doctor install:conflicts documentation, daemon automations tick/run-ledger documentation, daemon enumeration completeness, source-lock bump to 39feb6de.
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.

ci(docs): add canonical docs build, link, and browser journey

1 participant