Wes/core architecture client rework - #2749
Draft
bwreid wants to merge 6 commits into
Draft
Conversation
Adds three new MDX block components for packages/core/docs/content reference pages: Signature (a collapsible function/hook/action signature with parameter and return-type breakdown), and Image/Video (full width or aligned left/right with paired markdown text, alt text, and a caption). Video additionally supports reduced-motion-aware autoplay and looping. Documented all three on /docs/docs-components with live examples.
Hovering the image reveals a top-right button that opens it in a larger popup, matching the Escape/click-outside/close-button contract already established for diagrams. Paired left/right text and the caption render stacked below the image inside the popup instead of beside it, since the two-column layout only makes sense at the inline aligned size. Video is unchanged.
Adds a static "Function signature" caption above the component (no longer forced to uppercase, which mangled camelCase function names), and a thin border around the expanded parameter/return content so it's clear where the expanded state ends.
Covers app/ and public/: where the display of an agent-native app is built, the browser runtime pieces nothing else documents (root.tsx, AppProviders, entry points), and static assets. Links out to the focused Data & Sync and Agent Chat pages for the data/agent hooks.
Covers useActionQuery, useActionMutation, callAction, and useDbSync: the action hooks app/ uses to read, write, and stay live-synced with the same actions the agent calls. Examples are grounded in a real ticket-support reference app rather than a hypothetical domain.
Covers askUserQuestion, useAgentChatGenerating, sendToAgentChat, openAgentSettings, and dynamic suggestions: the client entry points into agent chat. Ordered around a running "Draft Response" ticket example, built up from askUserQuestion() through the full handler.
Contributor
Visual recap — skippedThe visual recap job did not run for this pull request. This is informational only and does not block the PR. Recap skipped for |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
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
1 participant
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.
Expands upon and improves the "Client" page of the Core Architecture section.