docs: add install & first run guide (guides checkpoint 2)#37
Merged
Conversation
First entry in the Guides catalog: five verified steps from nothing installed to a recorded session. Output shapes verified against coven-cli source (run_doctor prose, daemon-optional coven run, session banner). Extends check-guides-docs.mjs pins and links the catalog row. 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 the first concrete, end-to-end “Guides” entry to the docs catalog: an Install and First Run walkthrough that takes a user from a bare machine to a completed, recorded Coven session, and updates the Guides navigation + validation pins accordingly.
Changes:
- Add a new
install-and-first-runguide with prerequisites, 5 numbered steps, expected output, and troubleshooting links. - Link the new guide from the Guides catalog and register it in the Guides section
meta.json. - Extend
check-guides-docsto pin the new page and its required command/link mentions (including the install-debugging cross-link).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| content/docs/guides/install-and-first-run.mdx | New “Install and First Run” step-by-step guide with expected outputs and troubleshooting references. |
| content/docs/guides/index.mdx | Updates the Guides catalog table to link to the new guide. |
| content/docs/guides/meta.json | Registers install-and-first-run in the Guides section nav/pages list. |
| scripts/check-guides-docs.mjs | Pins the new guide page + required command mentions and enforces an install-debugging cross-link. |
This was referenced Jul 21, 2026
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 2 of the guides-section goal, stacked on #34: the first real guide in the catalog — Install and First Run — five verified steps from a bare machine to a recorded session.
Changes
content/docs/guides/install-and-first-run.mdx— prerequisites, 5 numbered steps (install CLI → doctor → harness auth → firstcoven run→ review sessions), expected output per step, troubleshooting footer linking intoreference/troubleshootinganchorscontent/docs/guides/index.mdx— catalog row now links to the guidecontent/docs/guides/meta.json— register the pagescripts/check-guides-docs.mjs— pin the new page, its command mentions, and the install-debugging cross-linkVerified against source (
../coven@ 2850c53)run_doctor/print_doctor_prose(main.rs:1556+): doctor report shape,[!!]/[OK]harness lines, install hints, Next steps blockdoctor_next_steps: exact harness install commands (npm install -g @openai/codex && codex login,@anthropic-ai/claude-code,claude doctor)coven run(guide says so, unlike older getting-started ordering)Coven session createdbanner (id/harness/cwd/title)run_daemon_command:Coven daemon: running (pid …, socket …)Validation
check-guides-docs,english-only,no-leading-h1,mermaid-parse,validate-links(0 errors) ✅npx tsc --noEmit+npx next build✅ —/docs/guides/install-and-first-runprerendered