docs: add set-up-the-daemon guide (guides checkpoint 4)#39
Merged
Conversation
Third catalog entry: start the daemon, verify via status and the /api/v1/health socket handshake, exercise with a session, restart/stop cleanly. Output strings verified against coven-cli run_daemon_command; health shape matches the socket-api reference and OpenAPI get-health. 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
Adds a new Guides-section walkthrough for setting up and validating the Coven daemon, and wires it into the guides navigation and CI/doc validation pins so it’s treated as a first-class guide in the docs site.
Changes:
- Adds a new Set Up the Daemon guide covering daemon start/status, health check over the Unix-socket HTTP API, session exercise, and restart/stop.
- Registers the new guide in the Guides index and
meta.jsonnav. - Extends
check-guides-docsto require the new page and pin key daemon command/API strings and a required lifecycle cross-link.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| scripts/check-guides-docs.mjs | Adds the new guide page to required pages and pins daemon lifecycle mentions/links. |
| content/docs/guides/set-up-the-daemon.mdx | New step-by-step guide for starting/validating/exercising/restarting/stopping the daemon. |
| content/docs/guides/meta.json | Registers set-up-the-daemon in the Guides nav pages list. |
| content/docs/guides/index.mdx | Links the new guide from the Guides catalog table. |
This was referenced Jul 22, 2026
- Simplify doctor prerequisite wording; add connect-a-harness prereq cross-link before the coven run step - Replace macOS-specific socket paths with <coven-home> placeholders - Derive the curl socket path from COVEN_HOME with a default Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Checkpoint 4 of the guides-section goal, stacked on #38: the Set Up the Daemon guide — start, verify health over CLI and socket API, exercise with a session, restart/stop cleanly.
Changes
content/docs/guides/set-up-the-daemon.mdx— 5 steps:daemon start→daemon status→curl --unix-socket … /api/v1/health→ run a session →restart/stop; stale-socket and service-manager pointers; troubleshooting footercontent/docs/guides/index.mdx— catalog row linkedcontent/docs/guides/meta.json— page registeredscripts/check-guides-docs.mjs— pins for daemon commands,/api/v1/health,coven.daemon.v1, and the lifecycle cross-linkVerified against source (
../coven@ 2850c53)run_daemon_command(main.rs:2714+): exact output strings —Coven daemon: running (pid …, socket …),restarted,stopped,was not running,not running+ optional hintcontent/docs/daemon/socket-api.mdxand the OpenAPIget-healthpage (both generated fromopenapi/coven.daemon.v1.yaml)Validation
check-guides-docs,english-only,no-leading-h1,mermaid-parse,validate-links(0 errors) ✅npx tsc --noEmit+npx fumadocs-mdx && npx next build✅ —/docs/guides/set-up-the-daemonprerendered (build initially omitted the new page silently until the .source map was regenerated — worth knowing for review)