Skip to content

docs(models): document registerBackend / defineBackend custom backends#554

Merged
kriszyp merged 3 commits into
mainfrom
docs/models-register-backend
Jun 30, 2026
Merged

docs(models): document registerBackend / defineBackend custom backends#554
kriszyp merged 3 commits into
mainfrom
docs/models-register-backend

Conversation

@heskew

@heskew heskew commented Jun 29, 2026

Copy link
Copy Markdown
Member

Summary

Documents the public custom-backend registration API (registerBackend / defineBackend) added in HarperFast/harper#1405.

  • reference/models/backends.md — new Custom backends section: defineBackend, registerBackend, the ModelBackend return shape, an in-process example, and the code-beats-config precedence note.
  • reference/models/api.md — a registerBackend() entry alongside the other models methods, linking to the guide.
  • reference/models/overview.md — notes that a call can route to a registered custom backend.

Companion

Docs for HarperFast/harper#1405 (which closes harper#1325 — the imperative custom-backend API). Operator config-file selection of custom backends is tracked separately in harper#1471 and is intentionally not documented here.

Version

<VersionBadge> is set to v5.1.15 — harper#1405 is merged and ships in that release.


Generated by an LLM (Claude Opus 4.8).

🤖 Generated with Claude Code

Covers the public custom-backend registration API added in
HarperFast/harper#1405: a Custom backends section in backends.md, a
registerBackend() entry in api.md, and an overview mention.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@heskew heskew added the content 📝 Content specific issues and requests - text, examples, missing info, or clarity label Jun 29, 2026
@heskew heskew requested a review from dawsontoth June 29, 2026 13:22
gemini-code-assist[bot]

This comment was marked as resolved.

@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-554

This preview will update automatically when you push new commits.

…tream return shape

Addresses gemini-code-assist review on #554.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions github-actions Bot temporarily deployed to pr-554 June 29, 2026 13:32 Inactive
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-554

This preview will update automatically when you push new commits.

…-only generate

#1405 (registerBackend/defineBackend) merged and ships in v5.1.15.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@heskew heskew marked this pull request as ready for review June 29, 2026 22:54
@heskew heskew requested a review from a team as a code owner June 29, 2026 22:54
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-554

This preview will update automatically when you push new commits.

@github-actions github-actions Bot temporarily deployed to pr-554 June 29, 2026 22:57 Inactive
@kriszyp kriszyp merged commit d37c984 into main Jun 30, 2026
7 checks passed
@kriszyp kriszyp deleted the docs/models-register-backend branch June 30, 2026 11:08
@github-actions

Copy link
Copy Markdown

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content 📝 Content specific issues and requests - text, examples, missing info, or clarity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants