docs: Create chatbot docs #151
Open
Conversation
This file contains 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
|
Ah - so a benefit to exposing each piece individually in the documentation, is they get a more thorough a11y review! :) |
edonehoo
reviewed
Sep 19, 2024
There was a problem hiding this comment.
As a general comment, I think the navigation plan is to have a top level "PatternFly AI" category, with "Chatbot" nested underneath (and also our AI guidelines).
So maybe something like this? Granted I may have a different opinion after getting to interact with the docs (surge 504), depending on the range of docs we will be adding
- PatternFly AI
- About PatternFly AI
- Ethics and guidelines
- Chatbot
- About chatbot - higher level overview and design guidelines with screenshots. maybe a table/outline of the different components available within the chatbot?
- Chatbot components - basic chatbot features, the stuff that is "required" or semi-required, unless that list is too long
- Chatbot attachments
- Writing for chatbots
- etc.
|
|
||
| ```js file="./Chatbot.tsx" isFullscreen | ||
|
|
||
| ### Chatbot container in various display modes |
There was a problem hiding this comment.
Suggested change
| ### Chatbot container in various display modes | |
| ### Container | |
| The chatbot container adapts to various display modes, as well as both light and dark themes. | |
If we were to call this page "chatbot components" we could maybe shorten some of these headings?
Comment on lines
+31
to
+35
| ### Chatbot content and message box | ||
|
|
||
| The `ChatbotContent` component is the container that is placed within the `Chatbot` between the [ChatbotHeader](/extensions/chat-bots--ai/chatbot-header) and [ChatbotFooter](/extensions/chat-bots--ai/chatbot-footer). | ||
| It usually contains a `ChatbotMessageBox` for displaying messages. | ||
|
|
There was a problem hiding this comment.
Suggested change
| ### Chatbot content and message box | |
| The `ChatbotContent` component is the container that is placed within the `Chatbot` between the [ChatbotHeader](/extensions/chat-bots--ai/chatbot-header) and [ChatbotFooter](/extensions/chat-bots--ai/chatbot-footer). | |
| It usually contains a `ChatbotMessageBox` for displaying messages. | |
| ### Chatbot content and message box | |
| The `<ChatbotContent>` component is the container that is placed within the `<Chatbot>`, between the [`<ChatbotHeader>`](/extensions/chat-bots--ai/chatbot-header) and [`<ChatbotFooter>`](/extensions/chat-bots--ai/chatbot-footer). | |
| It usually contains a `<ChatbotMessageBox>` for displaying messages. | |
Comment on lines
+48
to
+51
| ### Chatbot welcome prompt | ||
|
|
||
| The welcome prompt fills the message box before the user has input their first message to the chatbot. It can contain pre determined prompts | ||
|
|
There was a problem hiding this comment.
Suggested change
| ### Chatbot welcome prompt | |
| The welcome prompt fills the message box before the user has input their first message to the chatbot. It can contain pre determined prompts | |
| ### Welcome prompt | |
| The welcome prompt fills the message box before the user has input their first message to the chatbot. This message should welcome users to the chatbot experience and encourage them to interact. It may be helpful to display predetermined prompts as a starting point. | |
If there are a couple of general examples of predetermined prompts we could add at the end too
Comment on lines
+48
to
+51
| import PFHorizontalLogoColor from '../ChatbotHeader/PF-HorizontalLogo-Color.svg'; | ||
| import PFHorizontalLogoReverse from '../ChatbotHeader/PF-HorizontalLogo-Reverse.svg'; | ||
|
|
||
| ### Basic example |
There was a problem hiding this comment.
Suggested change
| import PFHorizontalLogoColor from '../ChatbotHeader/PF-HorizontalLogo-Color.svg'; | |
| import PFHorizontalLogoReverse from '../ChatbotHeader/PF-HorizontalLogo-Reverse.svg'; | |
| ### Basic example | |
| import PFHorizontalLogoColor from '../ChatbotHeader/PF-HorizontalLogo-Color.svg'; | |
| import PFHorizontalLogoReverse from '../ChatbotHeader/PF-HorizontalLogo-Reverse.svg'; | |
| ### Basic chatbot |
nicolethoen
force-pushed
the
create_chatbot_message_docs
branch
from
e723a9c
to
0c813be
Compare
rebeccaalpert
approved these changes
Sep 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.