Skip to content

docs(ui-sdk): expand Server Customisations guides - #247

Draft
govindavashishtha wants to merge 1 commit into
mainfrom
docs/ui-sdk-server-customisations
Draft

docs(ui-sdk): expand Server Customisations guides#247
govindavashishtha wants to merge 1 commit into
mainfrom
docs/ui-sdk-server-customisations

Conversation

@govindavashishtha

@govindavashishtha govindavashishtha commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

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 server config (TrueForge / TrueFoundry / raw AgentUIServer), TrueForge auth and optional catalog, sessions/turns/events, AgentChatServer and AgentBuilderServer cookbooks, catalog attachment, and layering chat + builder + catalog into one server.

Updated guides: Connect with TrueFoundry is trimmed to the minimal type: "truefoundry" example (long createTrueFoundryAgentUIServer / createTrueFoundryServer sections 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/* and ui-sdk/setup-custom-ui/* instead of older guides/ and concepts/ paths.

Note: putting-it-together and custom-server still link to #truefoundry-chat-your-own-builder on 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.

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
qaifi-tf marked this pull request as draft August 13, 2026 15:06
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.

1 participant