docs: slim README and reconcile duplicated doc pairs#457
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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.mdby 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.mdand documented translation staleness policy indocs/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.
|
|
||
| > `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: |
This was referenced Jul 22, 2026
Closed
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>
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.
Context
README.md,docs/MVP-PLAN.md,docs/GLOSSARY.md,docs/reference/glossary.md,docs/API-CONTRACT.md,docs/reference/api-contract.md,docs/reference/harness-adapters.md,docs/reference/roadmap.md,docs/DOCS-MAINTENANCE.mdImplementation
docs/reference/cli-*.md; kept the unique-prefix note and the rituals table (identity content).docs/reference/api.md,docs/API.md,docs/API-CONTRACT.md; kept the curl handshake + 4-step negotiation checklist and error-envelope rule.docs/daemon/coven-home.md,docs/daemon/configuration.md,docs/SETTINGS.md; kept CI tip, retention pointer, never-commit rule.copilot,crates/coven-cli/src/harness.rs); authority-boundary allowlist line now reads(codex, claude, copilot).docs/ROADMAP.md+docs/reference/roadmap.md. Nothing else changed.docs/reference/harness-adapters.mdanddocs/reference/roadmap.mdnow point at their canonical pages (docs/HARNESS-ADAPTERS.md,docs/ROADMAP.md).docs/reference/api-contract.mdclaimed error codes are<dotted.code>; the daemon emits snake_case codes (session_not_found, … —crates/coven-cli/src/api.rs), matchingdocs/API-CONTRACT.md. No content merged or moved.docs/es/docs/rulag English (last synced ~2026-06-24) and English is authoritative.COVEN_HOMEtip, never-commit-state rule. Everything cut is covered by the linked reference pages (verified per section).Verification
python scripts/check-secrets.py— passed (no current-tree or history findings)git diff --check— cleannode --test scripts/onboarding-docs-test.mjs— 13/13 passcargo fmt/clippy/test— n/a, docs-only changeRisk and Rollback
Agent Handoff
issue-447held for this work; release after merge.docs/reference/cli.md"Current harness ids" line still omitscopilot;--add-dirflag documented in HARNESS-ADAPTERS.md but missing fromdocs/reference/cli-run.md; es/ru translation sync pass pending (now documented in DOCS-MAINTENANCE.md); Windows CI flake tracked in flaky: threads_scheduler_recovers_veto_claimed_before_deadline times out its veto-deadline margin on windows-latest #455.