Skip to content

docs(adapters): add external-adapter discovery index + authoring guide#637

Merged
potiuk merged 1 commit into
mainfrom
docs/adapter-registry
Jun 29, 2026
Merged

docs(adapters): add external-adapter discovery index + authoring guide#637
potiuk merged 1 commit into
mainfrom
docs/adapter-registry

Conversation

@potiuk

@potiuk potiuk commented Jun 29, 2026

Copy link
Copy Markdown
Member

What

Completes the "link to adapters defined elsewhere" path (from the
vendor-neutrality work) with concrete artifacts.

  • docs/adapters/registry.md — a discovery-only index of:
    in-tree tool adapters per capability contract (shipping adapters +
    tracked extension points), in-tree organizations, and a table for
    community/external adapters kept in their authors' own repos.
    States the discovery-not-installation rule (PRINCIPLES §13) up front:
    nothing is auto-fetched; an external link is a pointer to evaluate,
    and adopters wire an adapter in deliberately.
  • docs/adapters/authoring.md — the step-by-step how-to: author a
    tool adapter (find the contract → implement → declare capability +
    ## Prerequisites + optional **Organization:** → wire into config →
    add an eval) or an organization, with the contribute-upstream vs
    keep-external trade-off table.

Wire-in

  • vendor-neutrality.md "Authoring your own adapter" now links both
    (the index reference was previously unlinked).
  • docs/index.md gains a "Find or author a backend adapter" row.
  • organizations/README.md points its authoring section at the guide.

Verification

doctoc, markdownlint, lychee (all relative links + anchors resolve),
placeholder check — green.

🤖 Generated with Claude Code

Completes the "link to adapters defined elsewhere" path with concrete
artifacts.

- docs/adapters/registry.md — a discovery-only index of in-tree tool
  adapters (per capability contract, with shipping adapters + tracked
  extension points), in-tree organizations, and a table for
  community/external adapters maintained outside the repo. States the
  discovery-not-installation rule (PRINCIPLES §13): nothing is
  auto-fetched; an external link is a pointer to evaluate, and adopters
  wire an adapter in deliberately.
- docs/adapters/authoring.md — the step-by-step how-to for authoring a
  tool adapter (find the contract → implement → declare capability +
  prerequisites + optional organization → wire in → add an eval) or an
  organization, with the contribute-upstream vs keep-external trade-off.

Wire-in: vendor-neutrality "Authoring your own adapter" now links both;
docs/index.md gains a "Find or author a backend adapter" row;
organizations/README points its authoring section at the new guide.

Generated-by: Claude Code (Opus 4.8)
@potiuk potiuk merged commit b98fc02 into main Jun 29, 2026
28 checks passed
@potiuk potiuk deleted the docs/adapter-registry branch June 29, 2026 06:11
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.

1 participant