Skip to content

docs: document three openai protocol wire variants - #553

Merged
smallnest merged 1 commit into
masterfrom
feat/issue-545-protocol-docs
Aug 2, 2026
Merged

docs: document three openai protocol wire variants#553
smallnest merged 1 commit into
masterfrom
feat/issue-545-protocol-docs

Conversation

@smallnest

Copy link
Copy Markdown
Owner

Summary

  • docs/web/configuration.html gains an "OpenAI wire variants" section listing openai / openai/chat / openai/resp_api, each with its endpoint meaning (EN + ZH data-*)
  • Added guidance on when to choose the Responses API (/responses) vs Chat Completions (/chat/completions), noting both require --base-url
  • Updated the protocol config-key row and the --protocol resolution step to enumerate all four accepted values
  • Markup validated (tag balance clean)

Closes #545

Test plan

  • HTML tag balance validated
  • All new elements carry both data-en and data-zh
  • Follows existing table + copy-wrap idiom

configuration.html now lists openai / openai/chat / openai/resp_api
with per-value endpoint meaning (EN + ZH), plus guidance on when to
choose the Responses API vs Chat Completions. Config-key row and the
provider-resolution list updated to match.
@smallnest
smallnest merged commit 073390a into master Aug 2, 2026
1 check passed
@smallnest
smallnest deleted the feat/issue-545-protocol-docs branch August 2, 2026 03:58
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.

文档:configuration.html 说明三个 protocol 值

1 participant