Skip to content

docs: document the v1.13.0 harness improvements across README, design.md, provider-guide #354

Description

@erain

Goal

v1.13.0 shipped eight harness improvements (#338#345) but the prose docs still describe the old behavior: README's Tools/Coding-tools/Long-context sections don't mention the edit repair ladder, head/tail truncation, retry/overflow recovery, guardrails, auto-continue, or the capability registry; design.md's loop walkthrough lacks the retry/guardrail/auto-continue steps; provider-guide doesn't cover declaring Capabilities; the roadmap doc still reads as a plan rather than a record.

Scope

  • README: update Tools (edit_file flexible matching + result echo), Coding tools (truncation/spool, assembled system prompt), Long context (structured snapshot, file ledger, overflow recovery), add a short "Harness reliability" paragraph (retries, guardrails, auto-continue — defaults and opt-outs).
  • docs/design.md: loop section steps for retry, guardrails, auto-continue; pointer to ADR-0017.
  • docs/provider-guide.md: declaring providers.Capabilities at registration.
  • docs/coding-harness-roadmap.md: mark the implementation order shipped (v1.13.0) per item.
  • docs/building-agents.md: spot-check for stale claims (retries now default-on).

Out of scope

Website repos (updated separately), CHANGELOG (done at release).

Verification commands

go build ./... # docs-only

Acceptance criteria

No doc describes pre-1.13 behavior as current; new knobs (RetryPolicy, GuardrailPolicy, AutoContinue, KeepRecentTokens, Capabilities, PromptSnippet) are discoverable from the README or guides.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions