Skip to content

docs: add connect-a-harness guide (guides checkpoint 3)#38

Merged
BunsDev merged 1 commit into
mainfrom
docs/guides-connect-harness
Jul 22, 2026
Merged

docs: add connect-a-harness guide (guides checkpoint 3)#38
BunsDev merged 1 commit into
mainfrom
docs/guides-connect-harness

Conversation

@BunsDev

@BunsDev BunsDev commented Jul 21, 2026

Copy link
Copy Markdown
Member

Summary

Checkpoint 3 of the guides-section goal, stacked on #37 (which stacks on #34): the Connect a Harness guide — choose, install, authenticate, verify, and run a harness through Coven.

Changes

  • content/docs/guides/connect-a-harness.mdx — 5 steps covering all four built-in harnesses (codex, claude, coven-code, copilot), provider-auth boundary, doctor verification, and failure-mode footer
  • content/docs/guides/index.mdx — catalog row linked
  • content/docs/guides/meta.json — page registered
  • scripts/check-guides-docs.mjs — pins for the new page, engine/adapter/copilot mentions, and the provider-auth cross-link

Verified against source (../coven @ 2850c53, crates/coven-cli/src/harness.rs)

  • Built-in harness table (harness.rs:523-695): exact executables and install hints — npm install -g @openai/codex / brew install --cask codex, @anthropic-ai/claude-code + claude doctor, coven engine install, npm install -g @github/copilot / brew install --cask copilot-cli + copilot login
  • selected_available_harness (main.rs:3894): unavailable harness fails fast with the doctor install hint
  • coven adapter install external-adapter path (grok/hermes recipes)

Validation

  • check-guides-docs, english-only, no-leading-h1, mermaid-parse, validate-links (0 errors) ✅
  • npx tsc --noEmit + npx next build ✅ — /docs/guides/connect-a-harness prerendered

Second catalog entry: choose, install, authenticate, and verify a
harness (Codex, Claude Code, Coven Code, Copilot), then run it through
Coven. Install hints and unavailable-harness behavior verified against
coven-cli harness.rs built-ins and selected_available_harness.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 21, 2026 23:57
@vercel

vercel Bot commented Jul 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
coven-docs Ready Ready Preview Jul 21, 2026 11:59pm

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Guides entry, Connect a Harness, expanding the step-by-step catalog with instructions for selecting, installing, authenticating, verifying, and running a harness (Codex, Claude Code, Coven Code, Copilot) under Coven supervision.

Changes:

  • Add a new “Connect a Harness” guide with numbered steps, expected output, and troubleshooting cross-links.
  • Register and link the new guide in the Guides nav (meta.json) and the Guides catalog (index.mdx).
  • Extend check-guides-docs to pin the new page, required command mentions, and the provider-auth boundary cross-link.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
scripts/check-guides-docs.mjs Adds connect-a-harness to required pages, pins additional harness-related mention strings, and enforces a provider-auth link in the new guide.
content/docs/guides/meta.json Registers connect-a-harness in the Guides section page list.
content/docs/guides/index.mdx Updates the catalog table to link to the new guide.
content/docs/guides/connect-a-harness.mdx New step-by-step guide for connecting and validating a harness (install → auth → doctor → run) with troubleshooting and related links.

@BunsDev
BunsDev changed the base branch from docs/guides-install-first-run to main July 22, 2026 00:37
@BunsDev
BunsDev merged commit 6703a40 into main Jul 22, 2026
2 checks passed
@BunsDev
BunsDev deleted the docs/guides-connect-harness branch July 22, 2026 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants