diff --git a/docs/docs/.vitepress/en.ts b/docs/docs/.vitepress/en.ts index c7da4e47..9525cd7f 100644 --- a/docs/docs/.vitepress/en.ts +++ b/docs/docs/.vitepress/en.ts @@ -1,3 +1,5 @@ +import { text } from "node:stream/consumers"; + export const en = [ { text: 'Overview', @@ -26,6 +28,10 @@ export const en = [ { text: 'Provider and Model', link: '/getting-started/provider-and-model.md' + }, + { + text: 'Create Bot', + link: '/getting-started/create-bot.md' } ] }, diff --git a/docs/docs/getting-started/create-bot.md b/docs/docs/getting-started/create-bot.md new file mode 100644 index 00000000..c46903c6 --- /dev/null +++ b/docs/docs/getting-started/create-bot.md @@ -0,0 +1,55 @@ +# Create Bot + + +## Prerequisites + +- Complete the provider and model configuration. + + +## Step 1: Open the Bot Page + +Click **Bots** in the left sidebar to open the Bots configuration page. + + +![Bots page - sidebar](/getting-started/bots-01-sidebar.png) + + +## Step 2: create a Bot + +Click the **New Bot** button (with a plus icon) + +![Create Bot button](/getting-started/bots-02-create-bot.png) + +In the dialog, fill in: + +| Field | Description | +|-------|-------------| +| **Name** | A display name for this bot (e.g. `my-bot`, `telegram-public-bot`) | +| **Avatar URL** | The API base Avatar (e.g.`https://gravatar.com/avatar/***`) | +| **Type** | Bots type: `person`, `public`, public for channel(e.g. `telegram` group, `qq` group, `discord` channel, person for bind user) | + +## Step 3: Bot Configuration + +Click one **bot** Card in Bots page + +![Bot Configuration](/getting-started/bots-03-config.png) + +open **settings** section + +![setting](/getting-started/bots-04-setting.png) + +select your available `Chat Model`, `Memory Model`, `Embedding Model` and save for basic Configuration + + +## Step 4: Check Bot + +Click **Chat** in the left sidebar to open chat page. +then type your prompt to test the Bot configuration + +![alt text](/getting-started/bots-05-chat.png) + + + +## Next Steps + +Once you have at least one bot, you can add bot **Platform** (e.g. `telegram`, `feishu(lark)`, `wechat`, `discord`) and manage **Memory** in bot settings. diff --git a/docs/docs/public/getting-started/bots-01-sidebar.png b/docs/docs/public/getting-started/bots-01-sidebar.png new file mode 100644 index 00000000..ad14f4a9 Binary files /dev/null and b/docs/docs/public/getting-started/bots-01-sidebar.png differ diff --git a/docs/docs/public/getting-started/bots-02-create-bot.png b/docs/docs/public/getting-started/bots-02-create-bot.png new file mode 100644 index 00000000..e52757c9 Binary files /dev/null and b/docs/docs/public/getting-started/bots-02-create-bot.png differ diff --git a/docs/docs/public/getting-started/bots-03-config.png b/docs/docs/public/getting-started/bots-03-config.png new file mode 100644 index 00000000..f56e002e Binary files /dev/null and b/docs/docs/public/getting-started/bots-03-config.png differ diff --git a/docs/docs/public/getting-started/bots-04-setting.png b/docs/docs/public/getting-started/bots-04-setting.png new file mode 100644 index 00000000..72e06c53 Binary files /dev/null and b/docs/docs/public/getting-started/bots-04-setting.png differ diff --git a/docs/docs/public/getting-started/bots-05-chat.png b/docs/docs/public/getting-started/bots-05-chat.png new file mode 100644 index 00000000..aa5fe9ec Binary files /dev/null and b/docs/docs/public/getting-started/bots-05-chat.png differ