Skip to content

[Automated] Draft docs (agentgateway): ui: show full model names in the model combobox (+1 related) - #1460

Open
github-actions[bot] wants to merge 3 commits into
mainfrom
pr-tracker-draft-agentgateway-4203-plus1
Open

github-actions[bot] wants to merge 3 commits into
mainfrom
pr-tracker-draft-agentgateway-4203-plus1

Conversation

@github-actions

@github-actions github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

[agentgateway/agentgateway#4203 and agentgateway/agentgateway#4204](agentgateway/agentgateway#4203 and agentgateway/agentgateway#4204) — UI model picker labels and headers

Docs versions: standalone/main. Not planned for kubernetes/main: no page found there. Check whether the change applies in that mode too

What changes for users: Standalone users can set llm.models[].displayName so the UI shows a friendly label while matching still uses llm.models[].name. Model pickers now distinguish models that share a match pattern, and the Playground and Client Setup use exact model match headers when the selected model requires them.

What the docs now say: The standalone LLM playground page now explains labels, distinguishing details, wildcard-specific model input, and exact match headers. The UI tour and Kubernetes UI page now say that Client Setup shows required exact headers and adds them to generated snippets.

Not verified: No cluster or UI run; the configuration is unrun, and internal links are unchecked because Hugo was not run.

How agentgateway-4203 was drafted, and what was not verified

Plan, and what changed it

  • Planned: Update the UI pages that describe model selection, Client Setup, and the LLM playground.
  • Learned: The #4204 diff adds llm.models[].displayName only to standalone config, while the Client Setup header behavior is in shared UI code used by the standalone and Kubernetes UI pages.
  • Did: Documented the standalone display-name behavior on the standalone UI tour, and documented exact-header behavior on the standalone Playground, standalone Client Setup, and Kubernetes Client Setup sections.

Why a documentation change is necessary

The pull requests change what readers see and copy from the UI when several models share a match pattern such as *. The existing Playground and Client Setup docs described selecting a model, but did not say that model labels and details identify otherwise identical entries or that exact match headers are added to generated requests. The generated configuration reference covers llm.models[].displayName, but the UI pages are where a reader learns what the field changes in practice.

What changed on disk

  • content/docs/standalone/main/documentation/llm/playground.md: Explains how the Playground model list distinguishes shared match patterns and sends exact match headers.
  • assets/agw-docs/standalone/setup/ui/launch.md: Adds main-gated UI tour text for llm.models[].displayName and exact-header snippets in Client Setup.
  • assets/agw-docs/pages/observability/ui.md: Adds main-gated Kubernetes Client Setup text for exact-header snippets.

How to verify this change

  1. Start agentgateway with a standalone configuration that has three llm.models entries named *, the same params.vertexProject, different params.vertexRegion values, two displayName values, and one exact match header such as x-team: ml.
  2. Open LLM > Models and LLM > Chat Playground. Each * model remains distinguishable by label or detail text, and selecting one entry keeps that entry selected.
  3. Open LLM > Client Setup and select the model with the exact header match. The Model field says that clients must send x-team: ml, and the generated curl snippet contains -H 'x-team: ml'.

What was not verified

  • The configuration was not applied to a cluster or run with a local agentgateway process, so the documented UI behavior is unrun.
  • Internal links are unchecked because Hugo was not run.
  • Screenshots were not refreshed.
How the pages were chosen (triage report)

Feature clusters

These pull requests document one feature between them:

Cluster Pull requests Product Why grouped
c1.2 agentgateway/agentgateway#4203, agentgateway/agentgateway#4204 agentgateway both are drafted into content/docs/standalone/latest/documentation/llm/playground.md, the only page a code-path rule names for one of them, so separate pull requests would conflict; the same author merged both within 24 hours, they change the same source file, and both are drafted into content/docs/standalone/latest/documentation/llm/playground.md, so this looks like one change split across pull requests and separate drafts would conflict; part 2 of 2 of 7 changes bundled onto content/docs/standalone/latest/documentation/llm/playground.md; each part is its own pull request, so the parts may conflict with each other on that page

Draft a documentation change

agentgateway/agentgateway#4203 — ui: show full model names in the model combobox

New configuration: no page mentions it yet

agentgateway/agentgateway#4204 — ui: tell apart models that share a match pattern

  • Product: agentgateway (upstream) → agentgateway/website
  • Docs version: standalone/main, kubernetes/main
  • Summary (read from the body): 🤖 written by Claude (start)
  • Not tested: no cluster was available, so every command in this diff is unrun

Release notes

This pull request also adds its release-note entries:

  • content/docs/standalone/main/release-notes/release-notes.md: Model pickers show labels, details, and required headers (feature, in a new 1.8 section)

Check these release-note links and names. Each note is on its page, but a link may not reach the drafted content there, or a name may belong to the other mode:

Draft branch: pr-tracker-draft-agentgateway-4203-plus1

…he model combobox (+1 related)

Drafts-Commit: 053e33e
Signed-off-by: GitHub Action <action@github.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Deploying agentproxy with  Cloudflare Pages  Cloudflare Pages

Latest commit: dd4d5cc
Status: ✅  Deploy successful!
Preview URL: https://e4da0c05.agentproxy.pages.dev
Branch Preview URL: https://pr-tracker-draft-agentgatewa-ca0f.agentproxy.pages.dev

View logs

The release-notes entry for this change now lives in the combined
release-notes PR, #1482, so the draft PRs no longer conflict on
the release-notes pages.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
@kristin-kronstain-brown

Copy link
Copy Markdown
Collaborator

Moved this PR's release-notes entry to the combined release-notes PR, #1482, so the draft PRs stop conflicting on the release-notes pages. Review or change the entry there.

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
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