docs: add harness deep dives#6
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds a first-class Harnesses deep-dive documentation section to the Coven docs site and introduces a build-time guard to ensure the section stays complete, cross-linked, and non-stubbed.
Changes:
- Added
content/docs/harnesses/docs section (meta + deep-dive pages covering concepts, install, auth boundary, project roots, cwd rules, adapters, and troubleshooting). - Wired the new section into top-level docs navigation (
content/docs/meta.json) and linked to it from existing Familiars docs. - Added
scripts/check-harness-docs.mjsand integrated it intonpm run buildascheck:harness-docs.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-harness-docs.mjs | New guard script validating Harnesses nav, required pages, and required cross-links/mentions. |
| package.json | Adds check:harness-docs and runs it during build. |
| content/docs/meta.json | Adds harnesses as a first-class top-level docs section. |
| content/docs/harnesses/meta.json | Defines Harnesses section metadata (title/description/icon/pages). |
| content/docs/harnesses/index.mdx | Harnesses landing page + runtime boundary overview and links to deep dives. |
| content/docs/harnesses/what-is-a-harness.mdx | Defines harness concept and boundaries vs daemon/familiars/clients. |
| content/docs/harnesses/installing.mdx | Installation + PATH detection guidance for Codex and Claude Code CLIs. |
| content/docs/harnesses/provider-auth.mdx | Provider-credential boundary explanation with cross-links to auth/security docs. |
| content/docs/harnesses/project-roots.mdx | Project-root resolution and boundary rationale + related links. |
| content/docs/harnesses/working-directories.mdx | --cwd validation rules and troubleshooting guidance. |
| content/docs/harnesses/codex.mdx | Codex-specific harness deep dive (setup/launch/supervision/common failures). |
| content/docs/harnesses/claude-code.mdx | Claude Code-specific harness deep dive (setup/launch/supervision/common failures). |
| content/docs/harnesses/custom-adapters.mdx | Guidance for future adapters and support bar/contract. |
| content/docs/harnesses/troubleshooting.mdx | Triage table + evidence checklist and cross-links. |
| content/docs/familiars/harnesses.mdx | Adds a pointer to the new first-class Harnesses deep dives section. |
| "title": "Harnesses", | ||
| "description": "Deep dives for Codex, Claude Code, provider auth, project roots, working directories, and adapter boundaries.", | ||
| "root": true, | ||
| "icon": "LuCable", |
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
Verification
Coauthored with Nova.