Skip to content

docs(provider): document custom registry format - #2864

Draft
LouisDM wants to merge 1 commit into
MoonshotAI:mainfrom
LouisDM:codex/issue-1366-custom-registry-docs
Draft

docs(provider): document custom registry format#2864
LouisDM wants to merge 1 commit into
MoonshotAI:mainfrom
LouisDM:codex/issue-1366-custom-registry-docs

Conversation

@LouisDM

@LouisDM LouisDM commented Aug 12, 2026

Copy link
Copy Markdown

Related Issue

Refs #1366

Problem

The provider documentation explains how to import a custom registry, but it does not document the api.json shape, required fields, capability metadata, or refresh behavior. Users therefore have to infer the format from implementation details.

What changed

  • add a minimal, neutral custom-registry example in both English and Chinese
  • document provider and model fields, supported provider protocols, and capability mapping
  • document same-URL refresh behavior, including additions, removals, metadata updates, and preservation boundaries
  • link the existing custom-registry entry point to the new section

This is intentionally limited to the documentation request. It does not add the longer-term /models discovery/import idea mentioned in the issue.

Verification

  • pnpm -C docs run build
  • git diff --check

Checklist

  • I have read the CONTRIBUTING document.
  • I have linked a related issue, or explained the problem above.
  • Documentation-only change; verified with a full VitePress build.
  • Ran gen-changesets; this documentation-only PR needs no changeset.
  • Ran gen-docs and verified the generated documentation build.

@changeset-bot

changeset-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 13bef00

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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