Skip to content

docs: refresh outdated model examples and add Chat Server page#2656

Merged
dgageot merged 1 commit intodocker:mainfrom
dgageot:docs/fix-outdated-and-add-chat-server
May 6, 2026
Merged

docs: refresh outdated model examples and add Chat Server page#2656
dgageot merged 1 commit intodocker:mainfrom
dgageot:docs/fix-outdated-and-add-chat-server

Conversation

@dgageot
Copy link
Copy Markdown
Member

@dgageot dgageot commented May 6, 2026

What

This PR fixes a few pieces of the docs that were outdated, plain wrong, or missing.

Outdated / wrong

  • Recommended Anthropic model – the docs were inconsistently using both claude-sonnet-4-0 (older) and claude-sonnet-4-5 (the current recommended default per docs/providers/anthropic/index.md). All example configs are now normalized to claude-sonnet-4-5. The Anthropic provider page still lists claude-sonnet-4-0 in the Available Models table as the previous generation.
  • Broken external link in docs/providers/openai/index.mdmodelname.ai returns a 404 ("This app isn't live yet"). Replaced with the correct modelnames.ai and added a link to the official OpenAI models doc.
  • Bedrock IAM-role example used the long-deprecated anthropic.claude-3-sonnet-20240229-v1:0 model id while every other example on the same page uses the current global.anthropic.claude-sonnet-4-5-20250929-v1:0. Made the IAM section consistent.

Missing

  • Chat Server feature pagedocker agent serve chat (the OpenAI-compatible chat-completions server) was documented as a CLI command in the CLI reference but had no dedicated feature page and no entry in the side navigation. Added docs/features/chat/index.md covering:
    • the /v1/models, /v1/chat/completions, and /openapi.json endpoints
    • quick-start with curl and the OpenAI Python SDK
    • server-side conversation caching (X-Conversation-Id)
    • bearer-token auth and CORS
    • Open WebUI integration recipe
    • the full flag table for docker agent serve chat
  • Wired the new page into docs/_data/nav.yml and added cross-links from the API server page and CLI reference.

How verified

Docs-only changes. Verified:

  • docs/_data/nav.yml is still valid YAML.
  • All updated model names are still recognized by the codebase (claude-sonnet-4-5 is the recommended default in docs/providers/anthropic/index.md, global.anthropic.claude-sonnet-4-5-20250929-v1:0 matches the rest of the Bedrock page).
  • modelnames.ai resolves; modelname.ai does not.

Files

  • New: docs/features/chat/index.md
  • Modified: docs/_data/nav.yml, docs/index.md, plus 14 other doc files updating model names and adding cross-links.

@dgageot dgageot requested a review from a team as a code owner May 6, 2026 09:52
Copy link
Copy Markdown

@docker-agent docker-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

Docs-only PR. Model name normalizations, the broken-link fix, and nav/cross-link updates all look correct. One factual inaccuracy was found in the new Chat Server page.

Comment thread docs/features/chat/index.md Outdated

## Endpoints

All endpoints live under the `/v1` prefix to match the OpenAI API surface.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[MEDIUM] Introductory claim contradicts the endpoint table

Line 47 states:

"All endpoints live under the /v1 prefix to match the OpenAI API surface."

But the table immediately below lists /openapi.json at the root level — not under /v1. This is confirmed by the actual server implementation in pkg/chatserver/server.go:

// Register /openapi.json *before* the bearer-auth middleware so the
// spec is publicly accessible.
e.GET("/openapi.json", s.handleOpenAPI)

The introductory sentence is factually incorrect. Consider changing it to something like:

"The two core API endpoints follow the OpenAI API surface under the /v1 prefix. The OpenAPI spec is served separately at /openapi.json."

Or simply remove the "all endpoints" claim and let the table speak for itself.

@dgageot dgageot force-pushed the docs/fix-outdated-and-add-chat-server branch from d63fb7e to 234c39e Compare May 6, 2026 12:02
- Bump example Anthropic model from claude-sonnet-4-0 to claude-sonnet-4-5
  (the recommended default per docs/providers/anthropic/index.md) across
  guides, configuration, tools, features, and the home page.
- Replace the broken modelname.ai link in the OpenAI provider page with
  the correct modelnames.ai and the official OpenAI models doc.
- Update the Bedrock IAM-role example from the long-deprecated
  anthropic.claude-3-sonnet-20240229-v1:0 model to the current
  global.anthropic.claude-sonnet-4-5-20250929-v1:0 used elsewhere on
  the page.
- Add a dedicated docs/features/chat/ page for 'docker agent serve chat'
  (the OpenAI-compatible chat-completions server), wire it into the
  navigation, and cross-link it from the CLI reference and API server
  pages.

Assisted-By: docker-agent
@dgageot dgageot force-pushed the docs/fix-outdated-and-add-chat-server branch from 234c39e to 2b7fb57 Compare May 6, 2026 12:06
@dgageot dgageot merged commit efa7527 into docker:main May 6, 2026
5 checks passed
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.

2 participants