docs: reshape canonical first-session and troubleshooting journey - #4
docs: reshape canonical first-session and troubleshooting journey#4CompleteDotTech wants to merge 1 commit into
Conversation
Make the first-session page the progressive end-user path from #775: install and verify, connect a harness, one recorded session, inspect the record, then an explicit recovery leg and grouped advanced next steps including `coven help --all`. Give Troubleshooting recovery rules and a journey-stage map so failures route back through doctor. Claims verified against OpenCoven/coven@main (crates/coven-cli/src/main.rs, setup/mod.rs, pc/mod.rs): command names, flags, and subcommands. Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
|
CI verdict on the unrelated failure — not caused by this PR's diff. Run: https://github.com/CompleteDotTech/coven-docs/actions/runs/33320333894 (check Root cause: time-based upstream contract drift.
Why this is not this PR's breakage: the diff (base None of the drifted upstream commits change commands, flags, or failure behavior asserted by these two pages (the codex relay, doctor shadowed-installs, automations tick, and setup version parsing do not alter All other pipeline stages pass locally on the head commit: typecheck, Per the branch contract this PR stays draft until the freshness gate is green again; it is ready to flip once the lock is re-certified (or the gate passes). |
Summary
Reshape the two docs-owned journey pages so
coven-docsis the progressive end-user path issue #775 asks for:guide/getting-startednow walks the whole first-session journey in order: install and verify (npm install -g @opencoven/cli→coven --version→coven doctor), connect a harness (coven setup codex|claude|copilot), run one recorded session (coven daemon start→coven run codex "explain this repo in 5 bullets"→coven sessions), inspect the record (coven sessions show/events/log,coven attach,coven status), then a new Recover when a step fails leg and an explicit Advanced next steps table (provider setup, harnesses, daemon, deployments, sessions, local API, memory as preview, hub/scheduler) pluscoven help --allfor the full grouped command surface. The old flat "Continue" list is replaced by that grouped expansion.reference/troubleshootingbecomes the explicit recovery leg of the journey: a new Recovery rules section (fix the first failing branch, rerundoctor, inspect before you mutate, sacrifice permanence) and a journey-stage → section map (install → harness → daemon → run → session). The existing ordered decision tree, error-code lookup, and all failure sections are unchanged, so every existing anchor stays valid.Docs-only diff (2 files, +80/−15). No CLI-reference pages touched.
Issue
Refs OpenCoven/coven#775 (child of OpenCoven/coven#670). Closes OpenCoven/coven#775 on upstream merge (cross-reference — GitHub cannot auto-close a
covenissue from this repository).How claims were verified
OpenCoven/coven@main(1364cec9dbaf1e2aca2e4544dec0e1ce807d859c):crates/coven-cli/src/main.rs(doctor,setup+Selector::{Codex,Claude,Copilot}and--verify,daemon start/status/restart/stop,runwith--cwd,sessions {search,show,events,log}with--plain/--manage/--all,attach,archive,sacrifice --yes,summon,status,pc),crates/coven-cli/src/help.rs(coven help --all),crates/coven-cli/src/pc/mod.rs(status/top/disk+--confirmrelief).docs/site-manifest.json: guide and reference arestableand owned byOpenCoven/coven-docs; memory-models is labeled "(preview)" in the advanced table; no experimental work is presented as supported.getting-startedonboarding mentions fromscripts/check-cli-docs.mjsare preserved verbatim.Test plan
pnpm run typecheck(afterpnpm exec fumadocs-mdxto regenerate.source)pnpm run check:content(site-manifest, source-lock, english-only, no-leading-h1, product-scope, fumadocs, daemon/cli/coven-code/harness/memory docs contracts, mermaid parse — 14 diagrams valid)pnpm run check:links— 0 errorspnpm run check:anchors— passed across 86 MDX pagespnpm run check:automation,pnpm run check:generated,pnpm run test:api-runner(23 pass)git diff --checkpnpm run build(Next.js production build) — deferred to CIpnpm run test:smoke(rendered-route assertions incl./docs/guide/getting-started→ "Run a first session") — deferred to CI