-
Notifications
You must be signed in to change notification settings - Fork 34
Fix: Updates overview page #772
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4f85b8f
fix: Replace broken links.
edonehoo 06708d4
Update casing of chatbot source in frontmatter
edonehoo d3b9260
Merge remote-tracking branch 'upstream/main'
edonehoo e26e544
fix: Updates overview page
edonehoo a3328a5
Apply suggestions from code review
edonehoo 05c9d9a
Update packages/module/patternfly-docs/content/extensions/chatbot/cha…
edonehoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
44 changes: 0 additions & 44 deletions
44
packages/module/patternfly-docs/content/extensions/chatbot/about-chatbot.md
This file was deleted.
Oops, something went wrong.
57 changes: 57 additions & 0 deletions
57
packages/module/patternfly-docs/content/extensions/chatbot/chatbot.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| id: Overview | ||
| title: ChatBot overview | ||
| section: extensions | ||
| subsection: ChatBot | ||
| sortValue: 1 | ||
| source: ChatBot | ||
| --- | ||
|
|
||
| **Note:** The PatternFly ChatBot extension lives in its own package [`@patternfly/chatbot`](https://www.npmjs.com/package/@patternfly/chatbot). | ||
|
|
||
| The PatternFly **ChatBot** extension contains a React implementation of an AI-focused chatbot, providing users with access to convenient and persistent help. This extension is intended to remain in alignment with our [AI principles and design guidelines](/ai/overview). | ||
|
|
||
| *Only use this ChatBot when it adds value to your users' experiences.* Don't use it simply for the sake of novelty—it must directly help users reach their goals. | ||
|
|
||
| --- | ||
|
|
||
| ## How do I use ChatBot? | ||
|
|
||
| To get started: | ||
| 1. Install the `@patternfly/chatbot` package by following [the README instructions](https://github.com/patternfly/chatbot). | ||
| 2. To use a ChatBot component in your project, import the ChatBot and the component you need. For example: `import ChatbotWelcomePrompt from '@patternfly/chatbot/dist/dynamic/ChatbotWelcomePrompt';` | ||
| 3. To build out and customize your ChatBot experience, refer to our extensive documentation on PatternFly.org. | ||
|
|
||
| ## What does a built-out ChatBot look like? | ||
|
|
||
| To illustrate holistic ChatBot solutions, we offer these interactive demos: | ||
| - [Basic ChatBot](/extensions/chatbot/overview/demo#basic-chatbot): A standard ChatBot that can swap between display modes. | ||
| - [Compact ChatBot](/extensions/chatbot/overview/demo#compact-chatbot): A compact version of a standard ChatBot that allows for more information density. | ||
| - [Embedded ChatBot](/extensions/chatbot/overview/demo#embedded-chatbot): A ChatBot experience that can be embedded into a page within an application. | ||
| - [Inline drawer ChatBot](/extensions/chatbot/overview/demo#inline-drawer-chatbot): A ChatBot placed within a drawer that is inline with page content, rather than one that overlays the page. | ||
|
|
||
| ## How do I build a ChatBot for my product? | ||
|
|
||
| To learn how to design ChatBot experiences, refer to [the design guidelines](/extensions/chatbot/overview/design-guidelines) and our [conversation design guidelines](/ai/conversation-design/). | ||
|
|
||
| Explore our documentation, which covers both the components you'll need to build your ChatBot and the guidance to follow for different functionality: | ||
| - UI: Structural, core components | ||
| - [Structural elements](/extensions/chatbot/ui#structure) | ||
| - [Toggle](/extensions/chatbot/ui#toggle) | ||
| - [Header](/extensions/chatbot/ui#header) | ||
| - [Footer](/extensions/chatbot/ui#footer) | ||
| - [Navigation](/extensions/chatbot/ui#navigation) | ||
| - [Modals](/extensions/chatbot/ui#modals) | ||
| - Messages: Components that customize features related to the conversation | ||
| - [Bot and user messages](/extensions/chatbot/messages) | ||
| - [File attachments](/extensions/chatbot/messages#file-attachments) | ||
| - Patterns: More opinionated implementation solutions for common use cases | ||
| - [Primary color background](/extensions/chatbot/overview/demo#primary-color-background) | ||
| - [Display mode switcher](/extensions/chatbot/overview/demo#display-mode-switcher) | ||
| - [Chat transcripts](/extensions/chatbot/overview/demo#chat-transcripts) | ||
| - [Analytics](/extensions/chatbot/analytics): Tracking for ChatBot interactions | ||
edonehoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [Customizing messages](/extensions/chatbot/customizing-messages): Details for the implementation of custom messages | ||
|
|
||
| --- | ||
|
|
||
| We will continue to grow and evolve our ChatBot. If you notice a bug or have any suggestions, feel free to file an issue in our [GitHub repository!](https://github.com/patternfly/chatbot/issues) Make sure to check if there is already a pre-existing issue before creating a new one. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.