Skip to content

docs: reshape canonical first-session and troubleshooting journey - #4

Closed
CompleteDotTech wants to merge 1 commit into
mainfrom
agent/issue-775-docs-reshape-canonical-first-session-and
Closed

docs: reshape canonical first-session and troubleshooting journey#4
CompleteDotTech wants to merge 1 commit into
mainfrom
agent/issue-775-docs-reshape-canonical-first-session-and

Conversation

@CompleteDotTech

Copy link
Copy Markdown
Owner

Summary

Reshape the two docs-owned journey pages so coven-docs is the progressive end-user path issue #775 asks for:

  • guide/getting-started now walks the whole first-session journey in order: install and verify (npm install -g @opencoven/clicoven --versioncoven doctor), connect a harness (coven setup codex|claude|copilot), run one recorded session (coven daemon startcoven 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) plus coven help --all for the full grouped command surface. The old flat "Continue" list is replaced by that grouped expansion.
  • reference/troubleshooting becomes the explicit recovery leg of the journey: a new Recovery rules section (fix the first failing branch, rerun doctor, 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 coven issue from this repository).

How claims were verified

  • Commands, flags, and subcommands checked against OpenCoven/coven@main (1364cec9dbaf1e2aca2e4544dec0e1ce807d859c): crates/coven-cli/src/main.rs (doctor, setup + Selector::{Codex,Claude,Copilot} and --verify, daemon start/status/restart/stop, run with --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 + --confirm relief).
  • Stability labels respected per docs/site-manifest.json: guide and reference are stable and owned by OpenCoven/coven-docs; memory-models is labeled "(preview)" in the advanced table; no experimental work is presented as supported.
  • Required getting-started onboarding mentions from scripts/check-cli-docs.mjs are preserved verbatim.

Test plan

  • pnpm run typecheck (after pnpm exec fumadocs-mdx to 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 errors
  • pnpm run check:anchors — passed across 86 MDX pages
  • pnpm run check:automation, pnpm run check:generated, pnpm run test:api-runner (23 pass)
  • git diff --check
  • pnpm run build (Next.js production build) — deferred to CI
  • pnpm run test:smoke (rendered-route assertions incl. /docs/guide/getting-started → "Run a first session") — deferred to CI

Vehicle note: opened in the fork CompleteDotTech/coven-docs as the CI vehicle — this token cannot write to OpenCoven/coven. Re-target upstream once write access is restored. Refs OpenCoven/coven#775.

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>
@CompleteDotTech CompleteDotTech self-assigned this Aug 30, 2026
@CompleteDotTech

Copy link
Copy Markdown
Owner Author

CI verdict on the unrelated failure — not caused by this PR's diff.

Run: https://github.com/CompleteDotTech/coven-docs/actions/runs/33320333894 (check Verify documentation release, failing step Verify upstream source freshness, pnpm check:source-drift).

Root cause: time-based upstream contract drift. docs/source-lock.json pins OpenCoven/coven@main at 9527145 verified 2026-08-26T09:58:12Z; three watched paths have newer commits upstream:

  • crates/coven-cli/src/main.rs — 3 commits (latest 3dd51ed3 2026-08-29, codex token-usage relay; also #849 doctor shadowed installs, #846 automations)
  • crates/coven-cli/src/api.rs — 2 commits (#846 automations daemon tick)
  • crates/coven-cli/src/setup/process.rs — 1 commit (#850 version parsing)

Why this is not this PR's breakage: the diff (base 5e348bd → head c532c04) touches only content/docs/guide/getting-started.mdx and content/docs/reference/troubleshooting.mdx. Both docs/source-lock.json and scripts/check-source-drift.mjs are byte-identical between base and head, and the same three-path drift reproduces on the head commit locally (ok: false, changedPathCount: 3). Any PR opened from current main — including a no-op diff — fails this gate today.

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 doctor/setup/daemon/run/sessions/attach/archive/sacrifice/status/pc/help --all surfaces documented here). Re-certifying the source lock against the new upstream commits is a maintainer re-verification task and is deliberately out of scope for this docs-only change.

All other pipeline stages pass locally on the head commit: typecheck, check:content (incl. CLI-docs onboarding mentions and mermaid parse), check:links (0 errors), check:anchors (86 pages), check:automation, check:generated, test:api-runner (23 pass), git diff --check. next build and test:smoke could not be observed in CI because the freshness gate exits first.

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).

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.

docs: reshape canonical first-session and troubleshooting journey

1 participant