ci(docs): smoke start, troubleshoot, reference, and integration journeys - #80
Open
CompleteDotTech wants to merge 2 commits into
Open
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>
|
@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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 #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 #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)