Skip to content

docs: slim README and reconcile duplicated doc pairs#457

Merged
BunsDev merged 1 commit into
mainfrom
docs/447-readme-slim
Jul 22, 2026
Merged

docs: slim README and reconcile duplicated doc pairs#457
BunsDev merged 1 commit into
mainfrom
docs/447-readme-slim

Conversation

@BunsDev

@BunsDev BunsDev commented Jul 22, 2026

Copy link
Copy Markdown
Member

Context

Implementation

  • Approach:
    • README slimming (908 → 714 lines). Identity/marketing sections (hero, badges, ecosystem table, MVP warning, What is Coven, Why Coven, Features, Requirements, Install, Quick Start, FAQ, Contributing, licensing/community) preserved intact. Slimmed bodies:
      • Commands Reference (~137 → ~33 lines): core-verb table with per-command links into docs/reference/cli-*.md; kept the unique-prefix note and the rituals table (identity content).
      • Local API (~91 → ~28 lines): contract summary pointing at docs/reference/api.md, docs/API.md, docs/API-CONTRACT.md; kept the curl handshake + 4-step negotiation checklist and error-envelope rule.
      • Configuration (~48 → ~16 lines): 3-row surface table pointing at docs/daemon/coven-home.md, docs/daemon/configuration.md, docs/SETTINGS.md; kept CI tip, retention pointer, never-commit rule.
      • Accuracy fixes while slimming: harness claims and install steps now include GitHub Copilot CLI (built-in harness id copilot, crates/coven-cli/src/harness.rs); authority-boundary allowlist line now reads (codex, claude, copilot).
    • docs/MVP-PLAN.md: historical banner under the H1 pointing at docs/ROADMAP.md + docs/reference/roadmap.md. Nothing else changed.
    • Stubs: docs/reference/harness-adapters.md and docs/reference/roadmap.md now point at their canonical pages (docs/HARNESS-ADAPTERS.md, docs/ROADMAP.md).
    • Diverged pairs: cross-reference banners added to both members of GLOSSARY / reference-glossary and API-CONTRACT / reference-api-contract identifying which is canonical/fuller. One outright contradiction fixed: docs/reference/api-contract.md claimed error codes are <dotted.code>; the daemon emits snake_case codes (session_not_found, … — crates/coven-cli/src/api.rs), matching docs/API-CONTRACT.md. No content merged or moved.
    • docs/DOCS-MAINTENANCE.md: new Translations section noting docs/es/docs/ru lag English (last synced ~2026-06-24) and English is authoritative.
    • Chunks deliberately kept in README (verified target docs before every cut): rituals semantics table, session-id unique-prefix note, curl health handshake + negotiation checklist, error-envelope rule, CI COVEN_HOME tip, never-commit-state rule. Everything cut is covered by the linked reference pages (verified per section).
  • User-visible behavior: docs-only; README shorter with pointers into the docs site tree. No route/file moves — all edits in place.
  • Compatibility notes: none (no code, no file renames; docs-site absolute routes untouched).

Verification

  • python scripts/check-secrets.py — passed (no current-tree or history findings)
  • git diff --check — clean
  • node --test scripts/onboarding-docs-test.mjs — 13/13 pass
  • cargo fmt/clippy/test — n/a, docs-only change
  • Relative-link sweep over root + docs (skipping es/ru/dist): 0 broken relative links after the change.

Risk and Rollback

  • Risk: low — docs-only, in-place edits. Worst case a pointer link is unclear; no information deleted that isn't covered by a linked doc.
  • Rollback: revert the single squash commit.

Agent Handoff

Slim the README's Commands Reference, Local API, and Configuration
sections into short pointer tables backed by the existing reference
docs; add GitHub Copilot CLI to the harness claims and install steps.
Mark docs/MVP-PLAN.md as historical, cross-link the diverged
GLOSSARY/API-CONTRACT doc pairs, point the reference stubs
(harness-adapters, roadmap) at their canonical pages, fix the error-code
style contradiction in reference/api-contract.md (dotted -> snake_case,
matching crates/coven-cli/src/api.rs), and document the es/ru
translation lag in DOCS-MAINTENANCE.md.

Closes #447

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Val Alexander <68980965+BunsDev@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 01:31

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

Docs-focused cleanup that makes README.md a slimmer entry point by replacing deep-detail sections with pointer tables into the existing docs/reference/* suite, while also adding “canonical/condensed” cross-links to reduce drift between duplicated doc pairs.

Changes:

  • Slimmed README.md by replacing the Commands Reference / Local API / Configuration deep sections with short link-backed tables and pointers.
  • Added canonical-content banners to stub reference pages (docs/reference/roadmap.md, docs/reference/harness-adapters.md) and added “see also” cross-links between duplicated docs (Glossary + API contract pairs).
  • Added a historical banner to docs/MVP-PLAN.md and documented translation staleness policy in docs/DOCS-MAINTENANCE.md.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
README.md Slims command/API/config sections into pointer tables; updates harness mentions to include GitHub Copilot CLI.
docs/MVP-PLAN.md Adds a “historical doc” banner pointing to the current roadmap.
docs/GLOSSARY.md Adds a cross-link banner to the condensed reference glossary.
docs/reference/glossary.md Adds a cross-link banner back to the canonical repo-root glossary.
docs/API-CONTRACT.md Adds a cross-link banner to the condensed reference contract page.
docs/reference/api-contract.md Adds a cross-link banner to the full contract and fixes error-code placeholder to snake_case.
docs/reference/harness-adapters.md Adds a canonical-content pointer to docs/HARNESS-ADAPTERS.md.
docs/reference/roadmap.md Adds a canonical-content pointer to docs/ROADMAP.md.
docs/DOCS-MAINTENANCE.md Adds a Translations section describing es/ru lag and English authority.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

> `attach`, `summon`, `archive`, `sacrifice`, `kill`, and the `sessions
> show/events/log` subcommands accept a unique prefix of the session id
The full command surface — every subcommand, flag, and JSON output shape — lives in [`docs/reference/cli.md`](docs/reference/cli.md), with dedicated per-command pages under [`docs/reference/`](docs/reference/). The core verbs:
@BunsDev
BunsDev merged commit 6614abc into main Jul 22, 2026
26 of 27 checks passed
@BunsDev
BunsDev deleted the docs/447-readme-slim branch July 22, 2026 01:49
BunsDev added a commit that referenced this pull request Jul 22, 2026
…dd-dir (#459)

Sweep the reference/topic docs that still claimed only Codex and Claude
Code where GitHub Copilot CLI is a shipped built-in harness, and add the
missing --add-dir row to the coven run reference.

Follow-up flagged in the bodies of merged PRs #453/#454/#457.

Closes #458

Signed-off-by: Val Alexander <68980965+BunsDev@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

docs: slim README and reconcile duplicated doc pairs in place

2 participants