Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(chatbot): Updates design guidelines with new info. #411

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

edonehoo
Copy link
Contributor

@edonehoo edonehoo commented Jan 17, 2025

Closes #386

Breaks apart the "message elements" section to add subsections for source tiles and quick start tiles.
https://chatbot-pr-chatbot-411.surge.sh/patternfly-ai/chatbot/overview/design-guidelines#source-tiles

Adds ChatBot settings and preferences guidance
https://chatbot-pr-chatbot-411.surge.sh/patternfly-ai/chatbot/overview/design-guidelines#chatbot-settings-and-preferences

Mentions custom toggle options
https://chatbot-pr-chatbot-411.surge.sh/patternfly-ai/chatbot/overview/design-guidelines#accessing-a-chatbot

And a few small image tweaks (like cropping) to help with readability/clarity

@patternfly-build
Copy link

patternfly-build commented Jan 17, 2025

Copy link
Contributor Author

@edonehoo edonehoo Jan 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note - our current attachment examples have the attachment chip placed below the user message, whereas Figma is the opposite. Does one or the other need to be updated?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The attachment should be below the message.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it got flipped around - Ill fix it in figma

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kaylachumley ty! Can you ping here once this is ready in Figma, so that I can go back & push an image update?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey! It's been ready to go but for some reason the updates are not pulling into your figma file but its showing up in the main patterns and extensions file @edonehoo

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got it to work for your file! @edonehoo

Copy link
Member

@rebeccaalpert rebeccaalpert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Just one comment about the QuickStarts tile.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The attachment should be below the message.

Copy link

@kaylachumley kaylachumley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good - left 1 comment

![Main elements of a ChatBot.](./img/chatbot-elements.svg)
</div>

1. **Container:** The window that contains the entire ChatBot experience and all of its components.
1. **Header:** A persistent region at the top of the ChatBot window that contains navigation, branding, and actions.
1. **Navigation:** A menu that contains navigational options, including access to the conversation history.
1. **Options menu:** Contains display options and other settings. More details can be found in the [ChatBot variations section](#variations).
1. **Options menu:** Contains display options (more details in the [ChatBot variations section](#variations)) and other settings (more details in the [ChatBOt settings and preferences section](#chatbot-settings-and-preferences)).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wonder if it would be helpful to mention that the options menu can be customized to the products preference. for example i dont think send feedback or help has to be included

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just pushed a phrasing update!

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.

Update design guidelines with new features
4 participants