docs: reshape canonical first-session and troubleshooting journey - #79
Open
CompleteDotTech wants to merge 2 commits into
Open
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>
|
@CompleteDotTech is attempting to deploy a commit to the 0xBuns Team on Vercel. A member of the Team first needs to authorize it. |
- doctor: document the new install:conflicts check (shadowed installs, prose Installs: section, path-free JSON warning, warn-not-fail exit code) - daemon: new Routine automations page covering the coven.automations capability, definition schema, 60-second scheduler tick, and run ledger - daemon: complete index/configuration/observability enumerations for automation routines in coven.sqlite3 and automations tick failures in daemon-recovery.log - source-lock: bump verification boundary to 39feb6de98816d10b490091e918f62035e6ce0df
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
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