docs: add install-debugging and uninstall guides for CLI and Coven Codes#21
Merged
Merged
Conversation
Add four dedicated guides and wire them into the sidebar: - cli/install-debugging.mdx, cli/uninstall.mdx - coven-codes/install-debugging.mdx, coven-codes/uninstall.mdx (new section) Also drop the duplicate leading H1 in reference/dispatch-contract.mdx so check:no-leading-h1 (and the full build) passes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds new troubleshooting and uninstall documentation for the Coven CLI and a new desktop-app docs section, and wires the new pages into the Fumadocs navigation. It also removes a duplicate leading H1 so the no-leading-h1 check passes.
Changes:
- Added CLI guides for install debugging and uninstall flows, including daemon/state considerations.
- Added a new
coven-codesdocs section with install-debugging and uninstall pages, and registered it in the root sidebar. - Removed the duplicate leading H1 from
reference/dispatch-contract.mdx.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/reference/dispatch-contract.mdx | Removes duplicate leading H1 to satisfy check:no-leading-h1. |
| content/docs/meta.json | Adds coven-codes to the top-level docs navigation. |
| content/docs/coven-codes/meta.json | Introduces a new “Coven Codes” docs section and its page list. |
| content/docs/coven-codes/install-debugging.mdx | New install/debugging decision flow and triage guidance for the desktop app. |
| content/docs/coven-codes/uninstall.mdx | New uninstall guidance for the desktop app, including app vs shared COVEN_HOME state. |
| content/docs/cli/meta.json | Adds CLI install-debugging and uninstall pages into the CLI sidebar ordering. |
| content/docs/cli/install-debugging.mdx | New CLI install-debugging guide (PATH, stale versions, native package resolution, source-build failures). |
| content/docs/cli/uninstall.mdx | New CLI uninstall guide (stop daemon, uninstall paths, verify, local state decision). |
Comment on lines
+13
to
+19
| Coven Codes is a first-party desktop application, distributed as a published build rather than an npm package. Use this page when installing or opening the app did not produce a working workspace. | ||
|
|
||
| <Callout type="info" title="Verify the current release channel"> | ||
| Coven Codes ships from [`OpenCoven/coven-codes` releases](https://github.com/OpenCoven/coven-codes/releases). Download the build that matches your OS and CPU, and confirm the current channel there before relying on any version-specific behavior. | ||
| </Callout> | ||
|
|
||
| Coven Codes is a client. It talks to the local `coven` daemon over the Unix socket at `~/.coven/coven.sock`, the same boundary every other client uses. It does not bypass daemon validation, and it should stay useful with clear fallback states even when Coven is not installed. Two failure classes matter here: the **app itself** will not install or launch, and the app launches but **cannot reach the daemon**. |
Comment on lines
+12
to
+28
| Use this page to remove the Coven Codes desktop app. Removing the app, clearing its own settings, and deleting shared Coven state are separate steps — a routine uninstall only needs the first. | ||
|
|
||
| ## Close The App First | ||
|
|
||
| Quit Coven Codes before removing it so no window is holding a connection to the daemon. Removing the app does not stop the `coven` daemon or end running sessions — the daemon is a separate process managed by the CLI. If you also want to stop background work, see [CLI Uninstall → Stop the daemon first](/docs/cli/uninstall#stop-the-daemon-first). | ||
|
|
||
| ## Remove The App | ||
|
|
||
| Uninstall using the method that matches how you installed the desktop build. | ||
|
|
||
| ### macOS | ||
|
|
||
| Quit the app, then move the bundle to the Trash: | ||
|
|
||
| ```sh | ||
| rm -rf "/Applications/Coven Codes.app" | ||
| ``` |
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.
What
Adds four dedicated guides and wires them into the sidebar navigation.
CLI (
content/docs/cli/, registered incli/meta.jsonafterinstall):install-debugging.mdx— decision flow + fast-triage table;covennot found (per install method), stale/wrong version, missing native platform package, source-build failures.uninstall.mdx— stop daemon → remove install (npm global / cargo / native binary) → verify → the separate decision about deleting~/.covenstate.Coven Codes (new
content/docs/coven-codes/section, added to rootmeta.json):install-debugging.mdx— app won't install/launch vs. app can't reach the daemon; per-OS installer gatekeeping (Gatekeeper/SmartScreen/AppImage); shared-COVEN_HOMErequirement.uninstall.mdx— per-OS app removal, app settings/cache locations, and a warning not to delete shared~/.covenstate to remove the app.Also removes the duplicate leading H1 in
reference/dispatch-contract.mdxsocheck:no-leading-h1(and the full build) passes.Notes
OpenCoven/coven-codes, shared~/.covensocket) and use the docs' "verify the current release channel" hedge rather than inventing version specifics. If the real repo slug, brand casing, or distribution channel differs, that's the thing to correct.Verification
check:cli-docs,check:english-only,check:no-leading-h1,validate-links(0 errors), mermaid, and fumadocs-platform checks all pass.🤖 Generated with Claude Code