docs: fix three guide inaccuracies found in post-merge review#46
Merged
Conversation
- 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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes a few post-merge technical inaccuracies in the Guides docs to better match current CLI/daemon behavior and expected outputs.
Changes:
- Adjusts upgrade verification guidance to rely on
ok+apiVersion(andcoven --version), notcovenVersionfrom health. - Updates memory guide prerequisites/troubleshooting to reflect that
coven memoryworks without a running daemon. - Corrects pinned
coven doctoroutput label from(built-in)to(built-in adapter)in relevant guides.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| content/docs/guides/upgrade-coven.mdx | Updates the health-check expectations to avoid relying on covenVersion for upgrade verification. |
| content/docs/guides/set-up-memory.mdx | Removes the daemon prerequisite for coven memory and replaces an invalid troubleshooting case. |
| content/docs/guides/install-and-first-run.mdx | Fixes pinned doctor output wording to match current CLI label. |
| content/docs/guides/connect-a-harness.mdx | Fixes pinned doctor output wording to match current CLI label. |
| ## 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). |
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.
Post-merge code review of the Guides chain (#34–#43) surfaced three technical inaccuracies, each verified against ../coven source:
coven memoryreads through the daemon API and could fail with a connection error. It is an in-process read (observe.rsapi_get→api::handle_request;api.rsroutesGET /memorytocockpit_sources::scan_memory) — matchescli/observe.mdx("work without a running daemon"). Dropped the daemon prerequisite and replaced the impossible troubleshooting bullet with aCOVEN_HOMEmismatch check.(built-in); the CLI prints(built-in adapter)(main.rsadapter_source_label, confirmed on v0.1.6).covenVersion" from/api/v1/health— released builds always report0.0.0(crate version). Verification now rests onok+apiVersion, withcoven --version(Step 2) as the version check.Validation: check-guides-docs, english-only, no-leading-h1, terminology, validate-links — all green.