Covendocs

Docs Issue Plan

Docs-first issue and milestone text for API, install, demo, plugin, harness, platform QA, and community roadmap work.

Docs Issue Plan

This page is the docs-first issue plan for Coven. It is not a GitHub issue tracker and it does not imply that issues or milestones have been created. If GitHub writes are authorized later, copy each row's title, scope, acceptance criteria, verification command, and links into the matching issue or milestone.

Planned Issue Groups

Docs-first issue groups
SlugPublic titleWhy it mattersVerification command
docs/api-contractComplete and keep current the Coven daemon API contractClient implementers need exact request, response, versioning, and error behavior before they build against Coven.npm run check:fumadocs && npm run check:mermaid && npm run check:links && npm run build && git diff --check
docs/installMake Coven installable without private contextNew users need a working install path before architecture or integration docs are useful.npm run check:fumadocs && npm run check:links && npm run build && git diff --check
docs/demo-loopDocument the CastCodes to Coven review loopUsers need to see how intent becomes a visible session, reviewable diff, and explicit finish action.npm run check:links && npm run build && git diff --check
docs/openclaw-pluginDocument the external OpenClaw bridge boundaryOpenClaw users need to understand that Coven is reached through an external plugin and the daemon API remains the trust root.npm run check:links && npm run build && git diff --check
docs/harness-compatMake harness adapter compatibility expectations concreteAdapter authors need to know what a supported harness must prove before it is advertised.npm run check:links && npm run build && git diff --check
docs/platform-qaQA the public docs platform surfacesSearch, graph, Mermaid, EPUB/PDF, and mobile layout must help users navigate the operational docs.npm run check:fumadocs && npm run check:mermaid && node scripts/check-mermaid-preview-ui.mjs && npm run check:links && npm run build && git diff --check
community/roadmap-loopKeep roadmap and issue text aligned with shipped realityPublic contributors need an honest, current work map without aspirational claims becoming implied support.npm run check:links && npm run build && git diff --check

Acceptance Criteria

docs/api-contract

Scope:

Acceptance criteria:

  • A client implementer can write a health handshake, launch request, event poller, input call, kill call, and error mapper from the docs.
  • Unversioned routes are described only as legacy aliases.
  • Non-live session behavior is explicit for completed, failed, killed, archived, and orphaned sessions.

docs/install

Scope:

Acceptance criteria:

  • A new user can install coven, run coven doctor, start the daemon, launch a Codex or Claude Code session, list sessions, and recover from common missing harness/socket errors.
  • Platform support statements match verified release artifacts or are clearly labeled planned/experimental.

docs/demo-loop

Scope:

Acceptance criteria:

  • A user can explain the demo flow end to end without knowing private project context.
  • Shipped Coven runtime behavior is separated from CastCodes UI hardening and roadmap syntax.

docs/openclaw-plugin

Scope:

Acceptance criteria:

  • The docs say the bridge is opt-in, uses GET /api/v1/health before launch, maps ACP requests to daemon sessions, and relies on compatibility tests for stability.
  • The docs do not imply provider credential proxying, OpenClaw-core coupling, raw socket tunneling, or broad plugin stability without tests.

docs/harness-compat

Scope:

Acceptance criteria:

  • Adapter authors can tell whether a harness is current, future, or unsupported.
  • A third harness proof must include install detection, provider auth posture, argv construction, project-root behavior, PTY lifecycle, event replay, live input/kill behavior, and client compatibility coverage.

docs/platform-qa

Scope:

  • Keep Docs Platform, search, graph, Mermaid UI, EPUB export, PDF export, and mobile layout useful.
  • Fix only scoped platform defects; do not redesign the whole site during QA.

Acceptance criteria:

  • Search returns useful results for install/API/harness terms.
  • Graph view renders and links real docs pages.
  • Mermaid preview/fullscreen/copy behavior works.
  • EPUB route and PDF export docs remain discoverable.
  • Mobile docs pages do not hide navigation or overflow core content.

community/roadmap-loop

Scope:

  • Keep Roadmap, Migration Map, and this page aligned with shipped reality.
  • Convert rows to GitHub issues/milestones only after explicit maintainer authorization.

Acceptance criteria:

  • Public docs distinguish shipped, now, next, later, lab, planned, and experimental work.
  • Issue text includes why, scope, acceptance criteria, verification command, and relevant docs links.
  • No GitHub issues or milestones are created from this page without explicit authorization.

Last updated on

On this page