docs(ui-sdk): expand Server Customisations guides - #247
Draft
govindavashishtha wants to merge 1 commit into
Draft
Conversation
Add Overview, Connect with TrueForge, and a Bring your own server group covering concepts, chat, catalog, agents, and composition, and fix broken internal links. Co-authored-by: Cursor <cursoragent@cursor.com>
qaifi-tf
marked this pull request as draft
August 13, 2026 15:06
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.
Note
Low Risk
Documentation-only changes with no SDK or server behavior impact. Minor risk of broken internal doc links to removed TrueFoundry composition sections.
Overview
This PR restructures the UI SDK “Server Customisations” docs and adds a Bring your own server guide series, without changing runtime code.
Navigation (
docs.json) adds an Overview, Connect with TrueForge, and a nested Bring your own server group (core-concepts,chat,catalog,agents,putting-it-together) ahead of Server contract. Connect with TrueFoundry stays a sibling entry.New pages walk through choosing a
serverconfig (TrueForge / TrueFoundry / rawAgentUIServer), TrueForge auth and optionalcatalog, sessions/turns/events,AgentChatServerandAgentBuilderServercookbooks, catalog attachment, and layering chat + builder + catalog into one server.Updated guides: Connect with TrueFoundry is trimmed to the minimal
type: "truefoundry"example (longcreateTrueFoundryAgentUIServer/createTrueFoundryServersections removed). Bring your own server drops the TrueFoundry-only note, adds attachment override and a “What’s next” card grid, and moves type-widening detail to Server contract.Cross-links across quickstart, architecture, troubleshooting, reference, and slot-overrides now point at
ui-sdk/setup-custom-servers/*andui-sdk/setup-custom-ui/*instead of olderguides/andconcepts/paths.Note:
putting-it-togetherandcustom-serverstill link to#truefoundry-chat-your-own-builderon Connect with TrueFoundry, but that anchor was removed in this PR—those links may 404 until restored or updated.Reviewed by Cursor Bugbot for commit f006b4b. Bugbot is set up for automated code reviews on this repo. Configure here.