Skip to content

Commit 1763b99

Browse files
committed
docs: Update settings and plugins page
1 parent f8d3fd5 commit 1763b99

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/api/settings.md

+2
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ const DefaultSettings: Settings = {
7070
disabled: false,
7171
maxEntries: 30,
7272
storageKey: "rcb-history",
73+
storageType: "LOCAL_STORAGE",
7374
viewChatHistoryButtonText: "Load Chat History ⟳",
7475
chatHistoryLineBreakText: "----- Previous Chat History -----",
7576
autoLoad: false,
@@ -328,6 +329,7 @@ Properties here handle the viewing of chat history.
328329
| disabled | `boolean` | false | Specifies whether chatbot chat history is disabled. |
329330
| maxEntries | `number` | 30 | The maximum number of chat history entries to display. |
330331
| storageKey | `string` | "rcb-history" | The key to use for storing chat history. Can be ignored if you only have a single instance of the chatbot on your website. Otherwise, if multiple chatbots share the same storage key, their chat history will overlap. |
332+
| storageType | `string` | "LOCAL_STORAGE" | The type of storage to use for chat history which can either be `LOCAL_STORAGE` or `SESSION_STORAGE`. |
331333
| viewChatHistoryButtonText | `string` | "Load Chat History" | The text to be displayed on the view chat history button. |
332334
| chatHistoryLineBreakText | `string` | "----- Previous Chat History -----" | The text to be displayed as a line break in the chat history. |
333335
| autoLoad | `boolean` | false | Specifies whether to automatically load chat history on start (requires `disabled` to be set to `false` as well) |

docs/concepts/plugins.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ For instructions on using plugins (both official or community-based), please ref
2222

2323
:::tip Tip
2424

25-
Most plugins tend to rely on chatbot [**events**](/docs/api/events) for their logic. As [**events**](/docs/api/events) are an opt-in feature, make sure you read the plugin's setup instructions in detail to understand which events are required to be enabled!
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!
2626

2727
:::
2828

2929
## Building Your Own Plugin
3030

31-
In the ideal scenario, there is already an existing plugin out there to address your use case. At times however, it may be necessary to build your own custom plugins. The chatbot is currently **already capable** of supporting plugins. However, the documentation for instructions on creating your own plugins are still a work-in-progress. These will be provided soon, latest by the **v2** stable release which is aimed for **late October 2024**.
31+
In the ideal scenario, there is already an existing plugin out there to address your use case. At times however, it may be necessary to build your own custom plugins. To assist you with creating your own plugins, a **skeleton repository has been setup with a comprehensive README** to guide you in the process. Kindly refer to the [**react-chatbotify-plugin-template**](https://github.com./React-ChatBotify-Plugins/react-chatbotify-plugin-template) repository to get started.
3232

33-
You may wish to join the [**discord**](https://discord.gg/6R4DK4G5Zh) to stay up to date with the latest information.
33+
If you're keen to dive into creating plugins, you are strongly encouraged to join the [**discord**](https://discord.gg/6R4DK4G5Zh) to stay up to date with the latest information and for ease of support.

0 commit comments

Comments
 (0)