From 8676120f4ded6e5568fd795f59498e93c6fdcb7a Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Mon, 19 Jan 2026 14:38:41 -0500 Subject: [PATCH 1/2] docs(desig-guidelines): Updates sources guidelines. --- .../extensions/chatbot/design-guidelines.md | 31 ++-- .../chatbot/img/source-tile-expanded.svg | 134 ++++++++++++++++++ .../chatbot/img/source-tile-summary.svg | 82 +++++++++++ .../extensions/chatbot/img/source-tile.svg | 47 +++--- 4 files changed, 269 insertions(+), 25 deletions(-) create mode 100644 packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-expanded.svg create mode 100644 packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-summary.svg diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md b/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md index 14140e502..2ba77ab76 100644 --- a/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md +++ b/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md @@ -55,14 +55,29 @@ To help users get started quickly, it can also be helpful to include welcome pro ![Welcome message with prompts.](./img/welcome-elements.svg) -#### Source tiles +#### Source cards -A ChatBot can share relevant sources with users, like documentation that could provide the information a user is searching for. These sources will be contained in a single tile, which users can paginate through and select to navigate to other resources. +To share relevant resources with users, like documentation containing the answer to a user's question, you can use source cards. -To provide users with enough context, sources should have descriptive titles and descriptions. The title is limited to 1 line and the body is limited to 2 lines. +
+![A white card below a message from a ChatBot. In the card is blue text for the title and black text for a short description. There are four pink annotation markers pointing to major sections of the image.](./img/source-tile.svg) +
+ +1. **Source count:** Notes the number of sources shared in a card. +2. **Source card title:** Offers a concise, descriptive title of the source content to provide users with quick context about a source. Titles are limited to 1 line and should be truncated when the text overflows or wraps. +3. **Source card description:** Offers a concise preview or summary of the source content. We recommend limiting the length to 2 lines to provide context without overcrowding the chat window. +4. **Pagination:** Used to navigate through all options when there are multiple source cards provided. Not displayed when only 1 source is provided. + +Instead of a short preview of the linked source's content, you can choose to summarize the contents and use that summary as your description. This is helpful for in-depth resources where the context is not clear from the beginning snippet. You can also choose to elevate a quote from the resource that is most relevant to the user's question. + +
+![A single source card is show below a chatbot message.](./img/source-tile-summary.svg) +
+ +While we generally recommend staying within 2 lines for your source description, you can choose to provide a "show more" link that allows users to expand and view a longer description. When using expandable descriptions, it is recommended to end the description at the end of the sentence. Use your best UX judgment here—extremely lengthy descriptions can quickly fill out the chat window and obstruct previous conversation details.
-![Bot message that include multiple source tiles.](./img/source-tile.svg) +![A before and after image is shown. The before image shows a single source card below a chatbot message, with a blue link at the bottom that says "show more." In the after image, additional description lines are shown and the link now says "show less."](./img/source-tile-expanded.svg)
#### Quick start tiles @@ -119,7 +134,7 @@ When users select either of these icons, you should present them with either: 1. **Close button (optional):** Closes the feedback form. The original feedback response should still be collected. 1. **Quick responses:** Options for users to provide more context around their rating. Customize these to make the most sense for your product. You can present positive and negative options based on the response type originally selected. 1. **Text area (optional):** Allows users to provide additional written detail if they'd like. - 1. **Submit button:** Submits the feedback form and triggers the thank-you card. + 1. **Submit button:** Submits the feedback form and triggers the thank-you card. ### Message bar @@ -205,7 +220,7 @@ To help users further identify the toggle, add a "Launch ChatBot" tooltip. You c ![Tooltips for ChatBot toggle.](./img/toggle-tooltips.svg) -Whichever method you choose, it is critical to be consistent with the toggle location and refer to the following the additional guidelines for each. +Whichever method you choose, it is critical to be consistent with the toggle location and refer to the following additional guidelines for each. #### Floating toggle When users click the toggle, the ChatBot window opens and the toggle will change to display an "angle down" icon to indicate that clicking the toggle again will minimize the ChatBot. Users can select the toggle at any point in their journey to open and close the ChatBot as needed. @@ -250,7 +265,7 @@ If a UI element within the page content is an AI/ChatBot-supported feature, the ![Menu item for an AI action that launches a ChatBot.](./img/ai-action-inpage.svg) -When a ChatBot is launches via an AI-supported action, the action should be sent as a user message once the ChatBot opens. +When a ChatBot is launched via an AI-supported action, the action should be sent as a user message once the ChatBot opens.
![User message in ChatBot for an AI action command.](./img/ai-action-message.svg) @@ -274,7 +289,7 @@ This can be done using the [quick response](/extensions/chatbot/messages#message ### Using the conversation history menu -The ChatBot history menu contains a log of a users' previous chats. Clicking the menu icon opens a side drawer in the ChatBot window. +The ChatBot history menu contains a log of a user's previous chats. Clicking the menu icon opens a side drawer in the ChatBot window. By clicking into the history menu, users can search through previous conversations and perform additional actions, such as sharing a conversation with others. diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-expanded.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-expanded.svg new file mode 100644 index 000000000..b0949b04d --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-expanded.svg @@ -0,0 +1,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-summary.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-summary.svg new file mode 100644 index 000000000..f8df2a58a --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile-summary.svg @@ -0,0 +1,82 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile.svg index 3c1398f9f..614cf39a2 100644 --- a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile.svg +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-tile.svg @@ -4,29 +4,42 @@ - - - - - - - + + + + + + + + - - + - - + + + - - - - + + + + + + + + + + + + + + + + @@ -41,7 +54,7 @@ - + @@ -57,6 +70,6 @@ - + From 5da32902e1e1f55ba6811f1049477ae6f0340b0d Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Tue, 20 Jan 2026 11:21:55 -0500 Subject: [PATCH 2/2] Updates from feedback, including custom source card subsection. --- .../extensions/chatbot/design-guidelines.md | 21 ++- .../chatbot/img/custom-source-card.svg | 37 +++++ .../chatbot/img/source-card-expanded.svg | 141 ++++++++++++++++++ .../chatbot/img/source-card-summary.svg | 83 +++++++++++ .../extensions/chatbot/img/source-card.svg | 76 ++++++++++ 5 files changed, 354 insertions(+), 4 deletions(-) create mode 100644 packages/module/patternfly-docs/content/extensions/chatbot/img/custom-source-card.svg create mode 100644 packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-expanded.svg create mode 100644 packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-summary.svg create mode 100644 packages/module/patternfly-docs/content/extensions/chatbot/img/source-card.svg diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md b/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md index 2ba77ab76..61b9cc5e1 100644 --- a/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md +++ b/packages/module/patternfly-docs/content/extensions/chatbot/design-guidelines.md @@ -60,7 +60,7 @@ To help users get started quickly, it can also be helpful to include welcome pro To share relevant resources with users, like documentation containing the answer to a user's question, you can use source cards.
-![A white card below a message from a ChatBot. In the card is blue text for the title and black text for a short description. There are four pink annotation markers pointing to major sections of the image.](./img/source-tile.svg) +![A white card below a message from a ChatBot. In the card is blue text for the title and black text for a short description. There are four pink annotation markers pointing to major sections of the image.](./img/source-card.svg)
1. **Source count:** Notes the number of sources shared in a card. @@ -71,15 +71,28 @@ To share relevant resources with users, like documentation containing the answer Instead of a short preview of the linked source's content, you can choose to summarize the contents and use that summary as your description. This is helpful for in-depth resources where the context is not clear from the beginning snippet. You can also choose to elevate a quote from the resource that is most relevant to the user's question.
-![A single source card is show below a chatbot message.](./img/source-tile-summary.svg) +![A single source card is show below a chatbot message.](./img/source-card-summary.svg)
-While we generally recommend staying within 2 lines for your source description, you can choose to provide a "show more" link that allows users to expand and view a longer description. When using expandable descriptions, it is recommended to end the description at the end of the sentence. Use your best UX judgment here—extremely lengthy descriptions can quickly fill out the chat window and obstruct previous conversation details. +While we generally recommend staying within 2 lines for your source description, you can choose to provide a "show more" button that allows users to expand and view a longer description. When using expandable descriptions, it is recommended to end the description at the end of the sentence. Use your best UX judgment here—extremely lengthy descriptions can quickly fill out the chat window and obstruct previous conversation details.
-![A before and after image is shown. The before image shows a single source card below a chatbot message, with a blue link at the bottom that says "show more." In the after image, additional description lines are shown and the link now says "show less."](./img/source-tile-expanded.svg) +![A before and after image is shown. The before image shows a single source card below a chatbot message, with a blue link at the bottom that says "show more." In the after image, additional description lines are shown and the link now says "show less."](./img/source-card-expanded.svg)
+##### Custom source cards + +You can create a custom source card by utilizing additional components that make sense for your use case. The source card's flexibility can be used in a number of ways, but the following example demonstrates how you might customize its appearance to provide additional details about a source. + +
+![A source card, annotated with four pink markers. Each marker points to a unique point of the card: a light gray subtitle below the main card title, a filled, green label beneath the card body that is labeled with a confidence % score, a blue help link is to the right of the green label that says "learn about this score", and light gray text at the bottom of the card with the last updated date.](./img/custom-source-card.svg) +
+ +1. **Subtitle:** Additional context about the resource, such as where the documentation is hosted. +2. **Label:** A confidence score, to indicate the likelihood that a source contains relevant information for the user. +3. **Link with popover:** Additional context about the confidence score label. +4. **Date:** The last time the linked resource was updated. + #### Quick start tiles A ChatBot can share a link to a [quick start](/extensions/quick-starts) that will help users complete a given task. Users can either select **Start** or the tile's title to initiate the linked quick start. diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/custom-source-card.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/custom-source-card.svg new file mode 100644 index 000000000..c66b31cc5 --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/custom-source-card.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-expanded.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-expanded.svg new file mode 100644 index 000000000..d81b4d737 --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-expanded.svg @@ -0,0 +1,141 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-summary.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-summary.svg new file mode 100644 index 000000000..1b92d0441 --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card-summary.svg @@ -0,0 +1,83 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card.svg b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card.svg new file mode 100644 index 000000000..1b7c3971e --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/chatbot/img/source-card.svg @@ -0,0 +1,76 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +