docs(conversational-ai): rework pattern README with grouped building-block previews#6265
docs(conversational-ai): rework pattern README with grouped building-block previews#6265rubencarvalho wants to merge 5 commits into
Conversation
|
📚 Branch Preview Links🔍 First Generation Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
rise-erpelding
left a comment
There was a problem hiding this comment.
This is a really nice update! I added a few suggestions/questions/comments but would be happy to approve if addressing them is not in scope!
rise-erpelding
left a comment
There was a problem hiding this comment.
This looks great!
Description
Reworks
2nd-gen/packages/swc/patterns/conversational-ai/README.mdxto be a more dynamic landing page for the Conversational AI pattern.FullPattern<Canvas>as the hero.<Canvas>previews — one per component — rendering each component'sOverview(orAnatomy/Loadingwhere more illustrative) story.<kbd>for keyboard keys in the thread description.Motivation and context
The previous README was a single intro paragraph, one full-pattern demo, and a static description table. Landing on this page didn't communicate how the pieces relate to each other or what each one looks like in isolation. The reworked layout walks readers through the pattern with live previews at each stage.
Related issue(s)
Screenshots (if appropriate)
N/A — Storybook page; rendered output visible by running the Storybook dev server on this branch and visiting Conversational AI → README.
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
README renders with all live previews
yarn storybookin2nd-gen/).<Canvas>blocks under "Building blocks" renders a live preview (prompt-field, upload-artifact, conversation-thread, conversation-turn, user-message anatomy, system-message, response-status loading, message-feedback, message-sources, suggestion-group, suggestion-item).Composition tree code block
swc-conversation-thread→swc-conversation-turn→ message → supporting parts nesting.Device review
Accessibility testing checklist
Keyboard (required — document steps below)
Screen reader (required — document steps below)