Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 44 additions & 238 deletions README.md

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/API-CONTRACT.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: "The versioned coven.daemon.v1 contract under /api/v1: health negot

# Coven local API contract

> **See also:** the condensed [API contract reference](reference/api-contract.md), which summarizes versioning and links per-topic pages under `docs/daemon/`. This page is the fuller single-page contract.

The Coven daemon socket API is a public compatibility boundary for comux and external clients such as external OpenClaw bridge plugin.

## Current stable version
Expand Down
4 changes: 4 additions & 0 deletions docs/DOCS-MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ Prefer relative repo links for internal docs:

Use full URLs only for external resources and public community links.

## Translations

`docs/es/` (Spanish) and `docs/ru/` (Russian) are partial translations of the English tree. They lag behind English (last synced around 2026-06-24) and are updated in dedicated translation-sync passes, not with every English change. The English pages are authoritative whenever a translation disagrees.

## Diagrams

Mermaid diagrams are allowed. Keep them small enough to read in GitHub's Markdown renderer.
Expand Down
2 changes: 2 additions & 0 deletions docs/GLOSSARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: "Definitions for Coven terms: CastCodes, ACP, API version, archive,

# Glossary

> **See also:** the condensed [reference glossary](/reference/glossary), which additionally defines future orchestration terms (affinity, handoff, harness capability, router). This repo-root page is the fuller canonical term list.

How the terms fit together at a glance:

```mermaid
Expand Down
2 changes: 2 additions & 0 deletions docs/MVP-PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: "End-to-end product and engineering plan for the Coven MVP: a Rust-

# Coven MVP Product + Implementation Plan

> **Historical planning document.** This plan is preserved for context and is no longer the source of current direction. For where Coven is heading now, see the [public roadmap](/ROADMAP) (`docs/ROADMAP.md`) and the [roadmap reference page](/reference/roadmap) (`docs/reference/roadmap.md`).

> **Historical framing note:** This plan captured the first Coven MVP path when comux was the proving cockpit. Current public product direction is CastCodes as the primary proof surface and Coven as the runtime that powers it. See [CastCodes and Coven integration](/CASTCODES-INTEGRATION) and [Roadmap](/ROADMAP) for current positioning.

> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/api-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ title: "API contract"
description: "Reference for the coven.daemon.v1 local API contract: how Coven adds fields and endpoints safely and when breaking changes require a new contract version."
---

> **See also:** the fuller single-page contract — shapes, error codes, cursor pagination, hub control plane — lives in [`API-CONTRACT.md`](/API-CONTRACT) (`docs/API-CONTRACT.md`). This page is the condensed versioning and negotiation summary.

Coven's local API is versioned as a **named contract**. The current value is `coven.daemon.v1`.

## Compatibility rules
Expand Down Expand Up @@ -64,7 +66,7 @@ All errors use the structured shape:
```json
{
"error": {
"code": "<dotted.code>",
"code": "<snake_case_code>",
"message": "<human-readable>",
"details": { "<context>": "<value>" }
}
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ title: "Glossary"
description: "Glossary of Coven and OpenCoven terms: CastCodes, ACP, coven.daemon.v1, harness, adapter, familiar, ritual, project root, archive, sacrifice, and capability."
---

> **See also:** the repo-root [Coven glossary](/GLOSSARY) (`docs/GLOSSARY.md`) is the fuller canonical term list; this reference page is a condensed view that adds future orchestration terms.

## ACP

Agent Client Protocol. In this repo, ACP appears as an integration surface for external agent runtimes and OpenClaw compatibility. Coven itself is not an ACP implementation; the external OpenClaw plugin maps between OpenClaw runtime events and Coven sessions.
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/harness-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ title: "Harness adapters"
description: "Reference for Coven harness adapters: the PTY contract, session metadata, project root canonicalization, and capability negotiation each adapter implements."
---

> Canonical content currently lives in the [harness adapter guide](/HARNESS-ADAPTERS) (`docs/HARNESS-ADAPTERS.md`). This reference page will be filled in once the adapter contract stabilizes.

Stub — fill in.
2 changes: 2 additions & 0 deletions docs/reference/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ title: "Roadmap"
description: "Roadmap reference for OpenCoven: CastCodes as the primary public workspace, Coven runtime, planned harness adapters, automation surface, and contract version milestones."
---

> Canonical content currently lives in the [public roadmap](/ROADMAP) (`docs/ROADMAP.md`). This reference page will be filled in as milestone detail stabilizes.

Stub — fill in.