Repository navigation
[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
Open
[Automated] Draft docs (agentgateway): ui: show full model names in the model combobox (+1 related)#1460github-actions[bot] wants to merge 3 commits into
github-actions[bot] wants to merge 3 commits into
Conversation
…he model combobox (+1 related) Drafts-Commit: 053e33e Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| 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 |
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>
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[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 forkubernetes/main: no page found there. Check whether the change applies in that mode tooWhat changes for users: Standalone users can set
llm.models[].displayNameso the UI shows a friendly label while matching still usesllm.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-4203was drafted, and what was not verifiedPlan, and what changed it
llm.models[].displayNameonly to standalone config, while the Client Setup header behavior is in shared UI code used by the standalone and Kubernetes UI pages.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 coversllm.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 forllm.models[].displayNameand 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
llm.modelsentries named*, the sameparams.vertexProject, differentparams.vertexRegionvalues, twodisplayNamevalues, and one exact match header such asx-team: ml.*model remains distinguishable by label or detail text, and selecting one entry keeps that entry selected.x-team: ml, and the generated curl snippet contains-H 'x-team: ml'.What was not verified
How the pages were chosen (triage report)
Feature clusters
These pull requests document one feature between them:
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 intocontent/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 ontocontent/docs/standalone/latest/documentation/llm/playground.md; each part is its own pull request, so the parts may conflict with each other on that pageDraft a documentation change
agentgateway/agentgateway#4203 — ui: show full model names in the model combobox
agentgateway/website--validate-onlyafter drafting, and commands are unrunNew configuration: no page mentions it yet
agentgateway/agentgateway#4204 — ui: tell apart models that share a match pattern
agentgateway/websiteRelease 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:
content/docs/standalone/main/release-notes/release-notes.md: ui: show full model names in the model combobox agentgateway#4203's note links to/documentation/observability/ui/, which has no page incontent/docs/standalone/mainDraft branch:
pr-tracker-draft-agentgateway-4203-plus1