docs: fix broken links and stale harness claims in entry-point docs#453
Merged
Conversation
Fixes the dangling docs/FUTURE-HARNESSES.md link in the README doc map and in the HARNESS-ADAPTERS adapter checklist (the page lives at docs/reference/future-harnesses.md), names GitHub Copilot CLI alongside Codex and Claude Code in the docs/index.md harness-support claims (it is a bundled built-in adapter, id "copilot"), and rewrites the stale CLI-reference card copy that enumerated only 8 commands. A relative-link sweep across root and docs/ markdown found no other broken relative targets. Closes #446 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-entry-point cleanup to eliminate a known 404 and align top-level docs with the current built-in harness set (Codex, Claude Code, and GitHub Copilot CLI), keeping onboarding copy accurate as the CLI surface grows.
Changes:
- Fix broken
Future harnesseslink to point at the existingdocs/reference/future-harnesses.md. - Update
docs/index.mdto include GitHub Copilot CLI in harness-support claims and diagrams. - Rewrite the landing-page CLI-reference card copy to avoid a stale fixed command list and instead point users at the full reference.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates the doc-map table to link to the correct future-harnesses reference page. |
| docs/index.md | Refreshes homepage copy/diagrams to include GitHub Copilot CLI and modernizes the CLI-reference card text. |
| docs/HARNESS-ADAPTERS.md | Updates the “Adding a new adapter” step to reference the correct future-harnesses page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
4 tasks
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
docs/FUTURE-HARNESSES.mdlink, updates stale harness-support claims indocs/index.mdto include GitHub Copilot CLI, and rewrites the stale CLI-reference card copy. In-place edits only; no files moved, renamed, or deleted.README.md,docs/HARNESS-ADAPTERS.md,docs/index.mdImplementation
README.md:672doc-map row now linksdocs/reference/future-harnesses.md(the file that actually exists);docs/FUTURE-HARNESSES.mddoes not.docs/HARNESS-ADAPTERS.md"Adding a new adapter" step 1 path reference updated the same way. (docs/MVP-PLAN.mdreferences left alone — historical doc, gets a banner in docs: slim README and reconcile duplicated doc pairs in place #447.)docs/index.md: "Harness-neutral" bullet, hero paragraph, capability card, PTY diagram, and thecoven doctorquick-start blurb now name Codex, Claude Code, and GitHub Copilot CLI — matchingbuilt_in_harness_specs()incrates/coven-cli/src/harness.rs(idcopilot) and the README Features section.docs/index.mdCLI-reference card no longer enumerates a stale 8-command list; it now describes core verbs + rituals and points at the full reference, so it stays accurate as the surface grows.*.mdanddocs/(excludingdocs/es,docs/ru,docs/dist, generated trees) with a throwaway resolver script: the FUTURE-HARNESSES row was the only broken relative link; zero remain after the fix. Site-absolute routes (/FUTURE-HARNESSESetc.) and external URLs were out of scope by design.Verification
python3 scripts/check-secrets.py— passed (no current-tree or history findings)git diff --check— cleannode --test scripts/onboarding-docs-test.mjs— 13/13 passmain(correctly reports the README:672 break) and against this branch (0 broken); every replacement target opened and confirmed topically correct; README doc-map table column alignment preserved.(Cargo gates not run locally: docs-only diff, no Rust/TS source touched.)
Risk and Rollback
Agent Handoff
specs/coven-harness-capabilities/PRODUCT.mdmentionsFUTURE-HARNESSES.mdin prose (inline code, not links) — left as-is, specs are historical snapshots.docs/es/docs/rutranslations still lag English; noted for the docs: slim README and reconcile duplicated doc pairs in place #447 maintenance-doc update.