Skip to content

Commit 19940b7

Browse files
committed
docs: Update docs about plugins and bump package dependencies
1 parent 88a0e30 commit 19940b7

File tree

5 files changed

+1806
-1686
lines changed

5 files changed

+1806
-1686
lines changed

docs/api/events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page documents all available `events` emitted by the chatbot that may be li
1212
- You are using [**plugins**](/docs/concepts/plugins) that relies on events emitted by the chatbot (you should refer to the plugin documentation for what events are needed)
1313

1414
:::tip Tip
15-
Before adding your own listeners with custom logic for events, it may be helpful to lookup existing [**plugins**](/docs/concepts/plugins) in case there's already a solution out there (e.g. [**rcb-input-validator-plugin**](https://github.com/react-chatbotify-plugins/rcb-input-validator-plugin)).
15+
Before adding your own listeners with custom logic for events, it may be helpful to lookup existing [**plugins**](/docs/concepts/plugins) in case there's already a solution out there (e.g. [**input-validator**](https://github.com/react-chatbotify-plugins/input-validator) plugin).
1616
:::
1717

1818
## Overview

docs/concepts/conversations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ For manipulating messages, it is recommended that you utilize `injectMessage` an
178178
</div>
179179
</div>
180180

181-
Toasts are strictly speaking not essential for chatbot conversations. However, they are oftentime useful in providing feedback to users (as **outlined in red** on the image above). For example, the [**rcb-input-validator-plugin**](https://github.com/react-chatbotify-plugins/rcb-input-validator-plugin) uses toasts to inform users of any input validation errors. A toast comprises of **3 properties**:
181+
Toasts are strictly speaking not essential for chatbot conversations. However, they are oftentime useful in providing feedback to users (as **outlined in red** on the image above). For example, the [**input-validator**](https://github.com/react-chatbotify-plugins/input-validator) plugin uses toasts to inform users of any input validation errors. A toast comprises of **3 properties**:
182182

183183
- id (required) - an auto-generated uuidv4 `string`, uniquely identifying a toast
184184
- content (required) - a `string` or `JSX.Element`, representing the content of the toast

docs/concepts/plugins.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,18 @@ A newly added feature in **v2** of the chatbot, the `plugins` prop provides user
1313

1414
There is a small group of official plugins maintained, which provide useful functionalities in common use cases. As of the last update, the list of official plugins are as below:
1515

16-
- [**rcb-input-validator-plugin**](https://github.com/react-chatbotify-plugins/rcb-input-validator-plugin) [Work-In-Progress]
17-
- [**rcb-message-transformer-plugin**](https://github.com/react-chatbotify-plugins/rcb-message-transformer-plugin) [Work-In-Progress]
16+
- [**Input Validator**](https://github.com/react-chatbotify-plugins/input-validator)
17+
- [**Markdown Parser**](https://github.com/react-chatbotify-plugins/markdown-parser)
18+
- [**llm-connector**](https://github.com/react-chatbotify-plugins/llm-connector) (WIP)
19+
- [**discord-live-chat**](https://github.com/react-chatbotify-plugins/discord-live-chat) (WIP)
1820

19-
If you strongly believe that there are common use cases with no suitable plugins, you may feel free to make a suggestion for one on [**discord**](https://discord.gg/6R4DK4G5Zh).
21+
If you strongly believe that there are common use cases with no suitable plugins, you may feel free to make a suggestion for one on [**discord**](https://discord.gg/J6pA4v3AMW).
2022

2123
For instructions on using plugins (both official or community-based), please refer to the plugin's documentation. Note that the maintenance of plugins are **separate** from the maintenance of the core React ChatBotify library.
2224

2325
:::tip Tip
2426

25-
Most plugins tend to rely on specific chatbot [**settings**](/docs/api/settings) for their logic (e.g. [**events**](/docs/api/events)). Ideally, plugin developers should provide auto-setup options out of the box. If not, make sure you read the plugin's setup instructions in detail to understand which settings are required to be enabled!
27+
Most plugins tend to rely on specific chatbot [**settings**](/docs/api/settings) for their logic (e.g. [**events**](/docs/api/events)). Ideally, plugin developers should provide auto-config options out of the box. If not, make sure you read the plugin's setup instructions in detail to understand which settings are required to be enabled!
2628

2729
:::
2830

0 commit comments

Comments
 (0)