From d039524affae4285ef51cb156f8a5b7e5a2bd6c6 Mon Sep 17 00:00:00 2001 From: Val Alexander Date: Tue, 21 Jul 2026 22:08:23 -0500 Subject: [PATCH] docs: fix three guide inaccuracies found in post-merge review - set-up-memory: coven memory is an in-process read of ~/.coven (observe.rs api_get -> api::handle_request), not a daemon API call; drop the daemon prerequisite and the impossible connection-error troubleshooting bullet - install-and-first-run, connect-a-harness: doctor prints '(built-in adapter)' (main.rs adapter_source_label), not '(built-in)' - upgrade-coven: released builds report covenVersion 0.0.0 (crate version), so verify upgrades via ok + apiVersion, not covenVersion Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- content/docs/guides/connect-a-harness.mdx | 2 +- content/docs/guides/install-and-first-run.mdx | 4 ++-- content/docs/guides/set-up-memory.mdx | 4 ++-- content/docs/guides/upgrade-coven.mdx | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/guides/connect-a-harness.mdx b/content/docs/guides/connect-a-harness.mdx index d44f936..998b6d8 100644 --- a/content/docs/guides/connect-a-harness.mdx +++ b/content/docs/guides/connect-a-harness.mdx @@ -73,7 +73,7 @@ coven doctor ```text Harnesses: - [OK] Codex `codex` is ready (built-in) + [OK] Codex `codex` is ready (built-in adapter) ``` If it still shows `[!!] … missing`, open a new terminal so `PATH` changes apply, then rerun `coven doctor`. Doctor's install hint under the failing line tells you the exact missing step. diff --git a/content/docs/guides/install-and-first-run.mdx b/content/docs/guides/install-and-first-run.mdx index c58a0f3..06e7393 100644 --- a/content/docs/guides/install-and-first-run.mdx +++ b/content/docs/guides/install-and-first-run.mdx @@ -47,7 +47,7 @@ Daemon: Not running Harnesses: - [!!] Codex `codex` is missing (built-in) + [!!] Codex `codex` is missing (built-in adapter) npm install -g @openai/codex && codex login ... @@ -79,7 +79,7 @@ Provider credentials belong to the harness, not to Coven — Coven never reads t ```text Harnesses: - [OK] Codex `codex` is ready (built-in) + [OK] Codex `codex` is ready (built-in adapter) ``` If the harness still shows missing, open a new terminal (so `PATH` changes apply) and run `coven doctor` again. diff --git a/content/docs/guides/set-up-memory.mdx b/content/docs/guides/set-up-memory.mdx index 41897a5..877414e 100644 --- a/content/docs/guides/set-up-memory.mdx +++ b/content/docs/guides/set-up-memory.mdx @@ -11,7 +11,7 @@ Coven's memory has two local surfaces: **persistent notes** — plain Markdown f ## Prerequisites -- The Coven CLI installed and the daemon running — `coven memory` reads through the daemon API; see [Set up the daemon](/docs/guides/set-up-the-daemon). +- The Coven CLI installed — `coven memory` reads `~/.coven` directly and works without a running daemon; see [Install and first run](/docs/guides/install-and-first-run). - For the semantic index steps: a Rust toolchain and a checkout of the [Coven repo](https://github.com/OpenCoven/coven) — the `coven-memory` binary builds from the workspace and is not part of the npm wrapper. - About 300 MB of disk for the embedding model, downloaded once on first ingest. @@ -76,7 +76,7 @@ Everything in this guide ran locally: embeddings are computed on your machine an ## Troubleshooting - **`coven memory` prints `No memory files.`** — the notes are not `.md` files directly under `~/.coven/memory//`; nested folders and other extensions are ignored. -- **`coven memory` fails with a connection error** — the daemon is down; see [Set up the daemon](/docs/guides/set-up-the-daemon) and [Daemon unavailable](/docs/reference/troubleshooting#daemon-unavailable). +- **`coven memory` shows nothing even though notes exist** — you are pointed at a different `COVEN_HOME`; run `coven doctor` and confirm the store path it reports. - **First ingest stalls** — it is downloading the embedding model; give it bandwidth once, subsequent runs are offline. - **Search returns another familiar's content** — you searched without `--familiar`; scope the query. - **Anything else** — [Memory search](/docs/memory-models/memory-search) and [Troubleshooting](/docs/reference/troubleshooting). diff --git a/content/docs/guides/upgrade-coven.mdx b/content/docs/guides/upgrade-coven.mdx index 175be50..0aef95d 100644 --- a/content/docs/guides/upgrade-coven.mdx +++ b/content/docs/guides/upgrade-coven.mdx @@ -64,7 +64,7 @@ curl --unix-socket "$HOME/.coven/coven.sock" \ http://localhost/api/v1/health ``` -**Expected output:** `"ok": true`, the new `covenVersion`, and — critically — `"apiVersion": "coven.daemon.v1"`, the contract your clients support. Scripts that use optional features should also check `GET /api/v1/capabilities` before relying on them. If a future release ever changes the contract, clients should fail closed with an update message rather than guess at response shapes — see [Recovery and upgrades](/docs/daemon/recovery-upgrades). +**Expected output:** `"ok": true` and — critically — `"apiVersion": "coven.daemon.v1"`, the contract your clients support. Do not verify the upgrade against the health body's `covenVersion` (released builds report the crate version, not the release tag — Step 2's `coven --version` is the version check). Scripts that use optional features should also check `GET /api/v1/capabilities` before relying on them. If a future release ever changes the contract, clients should fail closed with an update message rather than guess at response shapes — see [Recovery and upgrades](/docs/daemon/recovery-upgrades). ## Step 5 — Confirm your sessions survived