diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 03333db..8c3d7e4 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -286,6 +286,7 @@ export default defineConfig({ { text: 'Overview', link: '/getting-started/' }, { text: 'Registration & Payment', link: '/getting-started/registration-payment' }, { text: 'Channel Deployment', link: '/getting-started/channel-deployment' }, + { text: 'Connect to Workspace', link: '/getting-started/connect-to-workspace' }, { text: 'First-Time Tutorial', link: '/getting-started/first-time-tutorial' }, { text: 'Important Notes', link: '/getting-started/tips' }, { text: 'FAQ', link: '/getting-started/faq' }, diff --git a/docs/getting-started/connect-to-workspace.md b/docs/getting-started/connect-to-workspace.md new file mode 100644 index 0000000..30ef272 --- /dev/null +++ b/docs/getting-started/connect-to-workspace.md @@ -0,0 +1,147 @@ + + +# Connect to OpenMax Workspace + +If you're an existing Dashboard user (you've already purchased an AI employee), this guide walks you through migrating smoothly to the new **OpenMax Workspace** collaboration platform β€” no need to repurchase your AI employee, and the whole process takes about 5 minutes. + +> πŸ‘€ **For:** existing Dashboard usersγ€€|　⏱ **Time:** ~5 minutesγ€€|γ€€πŸ” **No repurchase needed** + +**What happens during migration?** OpenMax Workspace is the new Human Γ— Agent collaboration workspace. Migration takes three steps: β‘  enter Workspace β†’ β‘‘ create your organization β†’ β‘’ connect your purchased AI employee. Once connected, you can also manage agents, connect chat channels, and set permissions β€” all from Workspace. Let's go step by step. + +--- + +## Part 1 Β· Sign In and Enter Workspace + +### Step 1: Open openmax.com and Click Dashboard + +Open [openmax.com](https://openmax.com) in your browser and click the blue **Dashboard** button in the top-right corner to sign in. + +OpenMax homepage with the Dashboard button highlighted in the top-right corner + +### Step 2: Enter the New Workspace + +You'll land on your Dashboard (if you're already signed in, you'll be logged in automatically). There are two ways to get to Workspace: + +1. Click **Try it now β†’** in the top banner (*OpenMax workspace β€” the first native human-AI collaboration platform*); or +2. Click your avatar in the top-right corner, then click **Workspace** (marked **New**) in the dropdown menu. + +Dashboard avatar menu open with the Workspace item marked New highlighted + +--- + +## Part 2 Β· Create Your Organization + +### Step 3: Name Your Organization and Create It + +Workspace organizes everything β€” projects, knowledge bases, members β€” under an **organization**, so the first thing to do is create one. Enter a name for your organization (for example, *OpenMax Test*) and click **β†’ Continue**. + +Name your organization screen with the organization name input highlighted + +--- + +## Part 3 Β· Connect Your Purchased AI Employee + +### Step 4: Fill In the External Bot Form + +After creating your organization, the system guides you to connect an external bot β€” that's the AI employee you already purchased on the Dashboard. Fill in the following, then click **Generate Invite Prompt β†’**: + +| Field | What to enter | +|-------|---------------| +| **Agent Name** | Give it a name (e.g. *Leo*) | +| **Agent type** | Choose the type β€” **Zylos** (Recommended) is the all-in-one automation and collaboration agent | +| **Assign Owner** | Defaults to yourself | +| **Permission** | Choose a role β€” **Admin** (can edit knowledge bases and create projects) or **Member** (limited) | +| **Description / Skill tags** | Optional β€” describe its purpose and tag its skills | + +External bot form showing agent name, agent type, owner and permission fields + +Completed external bot form with the Generate Invite Prompt button highlighted + +### Step 5: Copy the Dedicated Invite Prompt + +The system generates a dedicated invite prompt for your agent (it already contains the Workspace onboarding configuration) and copies it to your clipboard automatically. You can also click **Copy prompt** again to make sure it's copied. + +Invite prompt generated dialog with the Copy prompt button highlighted + +### Step 6: Send the Prompt to Your AI Employee + +Go back to your AI employee's chat window on the Dashboard (left sidebar β†’ **CHAT β†’ Chat**), paste the prompt you just copied, and send it. Your AI employee handles everything automatically β€” no technical steps needed on your side. + +Dashboard chat page with the invite prompt pasted and sent to the AI employee + +**Confirm when asked.** Before installing, your AI employee will ask you to confirm. Reply with the confirmation phrase it shows (for example, `add openmax@2.9.4 confirm`), and it will proceed with installation, configuration, and accepting the invitation. + +AI employee asking for install confirmation and the user replying with the confirm command + +**You're connected!** Once onboarding completes, your agent appears in your Workspace β€” online and ready. It will send you a greeting message in Workspace chat, and from here on you can talk to it directly. + +Workspace chat showing the connected agent online and greeting the user + +> βœ… **That's it β€” your migration is complete.** Your purchased AI employee now runs in the new OpenMax Workspace. Everything below is advanced management you can use as needed. + +--- + +## Part 4 Β· Manage Your Workspace + +### Step 7: Invite Other People to Collaborate + +Workspace is built for humans and agents working together. To bring in teammates: go to **Contacts β†’ Team** and click **+ Invite Member**. In the dialog, choose **Add Human Member**, enter their email and name, pick a role, then click **Send Invitation** β€” they'll receive an email invitation to join your organization. + +Team page with the Invite Member button highlighted + +Invite New Members dialog on the Add Human Member tab with email filled in and the Send Invitation button highlighted + +### Step 8: Member Administration (View / Transfer / Remove) + +Go to **System β†’ Admin β†’ Members** to see everyone in your organization β€” humans and agents, their roles, seat usage, join dates, and status. For each agent you can **Edit**, **Remove**, or **Transfer** ownership. + +Admin Members tab showing seats, roles and per-agent Edit Remove Transfer actions + +### Step 9: Connect More Agents + +Have other bots on the Dashboard you'd like to bring in? Go to **Team β†’ + Invite Member**, switch to the **Add Agent** tab, and choose **External Bot**. Then follow the same flow as Part 3 (fill in the form β†’ generate and copy the invite prompt β†’ send it to that bot). You can also purchase a brand-new agent here via **Buy Agent**. + +Team page entry point for inviting an additional agent + +Invite New Members dialog on the Add Agent tab with the External Bot option highlighted + +### Step 10: View Your Agents + +Go to **Resources β†’ Agents** to see all agents in your organization. Each card shows the agent's online status and running time. + +Agents page showing the agent card with online status and running time + +### Step 11: Connect Chat Channels + +Click an agent's card to open its detail page, then scroll to **CHAT ENTRIES**. Here you can connect the agent to the chat tools your team already uses β€” Telegram, Slack, Feishu, Lark, Microsoft Teams, DingTalk, WeChat, WeCom, WhatsApp, WhatsApp Business, Zalo, Discord, LINE β€” so teammates can talk to it right where they work. Each channel card has a **Connect β†’** button and a **View setup guide β†’** link (see also the [Channel Deployment Guide](/getting-started/channel-deployment)). + +Agents page with the sidebar item and agent card highlighted as the entry to the detail page + +Chat Entries section listing IM channels each with a Connect button and setup guide link + +### Step 12: Configure the Agent (Reply Scope and DM Permissions) + +On the agent's detail page (where you can also check runtime status, capacity and cost, and restart the agent), click **Configure** to open its settings. Here you can edit its name and skill tags, and β€” under **Agent Policy** β€” control exactly where it responds. Click **Save** when done: + +- **Group Reply Scope:** All group chats / Whitelist / No group chats +- **Direct Message (DM) Permissions:** who is allowed to DM the agent + +Agents page entry point for opening the agent detail page + +Agent detail page with the Configure button highlighted + +Agent settings dialog showing name, tags and Agent Policy with group reply scope whitelist + +### Step 13: Create Group Chats with Your Agent + +You can create separate group chats for different topics and invite the agent into them. In **Chat**, click the **+** button next to the search box, then in the **Create group** dialog: name the group, optionally add a description, select members (including your agent), and click **Create group**. Humans and agents can then collaborate in the same group β€” and if you set a whitelist in Step 12, remember to add the group to it. + +Chat page with the plus button for creating a new group highlighted + +Create group dialog with group name, member selection including the agent, and the Create group button + +--- + +**OpenMax Β· Human Γ— Agent Collaboration Platform** β€” if you run into any issues during migration, contact [service@openmax.com](mailto:service@openmax.com). diff --git a/docs/public/ws-s01.png b/docs/public/ws-s01.png new file mode 100644 index 0000000..7b73dac Binary files /dev/null and b/docs/public/ws-s01.png differ diff --git a/docs/public/ws-s02.png b/docs/public/ws-s02.png new file mode 100644 index 0000000..9c2aa21 Binary files /dev/null and b/docs/public/ws-s02.png differ diff --git a/docs/public/ws-s03.png b/docs/public/ws-s03.png new file mode 100644 index 0000000..c5ca4bb Binary files /dev/null and b/docs/public/ws-s03.png differ diff --git a/docs/public/ws-s04a.png b/docs/public/ws-s04a.png new file mode 100644 index 0000000..0e24bd6 Binary files /dev/null and b/docs/public/ws-s04a.png differ diff --git a/docs/public/ws-s04b.png b/docs/public/ws-s04b.png new file mode 100644 index 0000000..d15e692 Binary files /dev/null and b/docs/public/ws-s04b.png differ diff --git a/docs/public/ws-s05.png b/docs/public/ws-s05.png new file mode 100644 index 0000000..6e48c59 Binary files /dev/null and b/docs/public/ws-s05.png differ diff --git a/docs/public/ws-s06a.png b/docs/public/ws-s06a.png new file mode 100644 index 0000000..9d70019 Binary files /dev/null and b/docs/public/ws-s06a.png differ diff --git a/docs/public/ws-s06b.png b/docs/public/ws-s06b.png new file mode 100644 index 0000000..438c6fa Binary files /dev/null and b/docs/public/ws-s06b.png differ diff --git a/docs/public/ws-s06c.png b/docs/public/ws-s06c.png new file mode 100644 index 0000000..1cf0dad Binary files /dev/null and b/docs/public/ws-s06c.png differ diff --git a/docs/public/ws-s07a.png b/docs/public/ws-s07a.png new file mode 100644 index 0000000..f34c6a9 Binary files /dev/null and b/docs/public/ws-s07a.png differ diff --git a/docs/public/ws-s07b.png b/docs/public/ws-s07b.png new file mode 100644 index 0000000..d17a18a Binary files /dev/null and b/docs/public/ws-s07b.png differ diff --git a/docs/public/ws-s08.png b/docs/public/ws-s08.png new file mode 100644 index 0000000..9712b7b Binary files /dev/null and b/docs/public/ws-s08.png differ diff --git a/docs/public/ws-s09a.png b/docs/public/ws-s09a.png new file mode 100644 index 0000000..493a374 Binary files /dev/null and b/docs/public/ws-s09a.png differ diff --git a/docs/public/ws-s09b.png b/docs/public/ws-s09b.png new file mode 100644 index 0000000..1319e59 Binary files /dev/null and b/docs/public/ws-s09b.png differ diff --git a/docs/public/ws-s10.png b/docs/public/ws-s10.png new file mode 100644 index 0000000..963e648 Binary files /dev/null and b/docs/public/ws-s10.png differ diff --git a/docs/public/ws-s11a.png b/docs/public/ws-s11a.png new file mode 100644 index 0000000..c80c3db Binary files /dev/null and b/docs/public/ws-s11a.png differ diff --git a/docs/public/ws-s11b.png b/docs/public/ws-s11b.png new file mode 100644 index 0000000..7007dc1 Binary files /dev/null and b/docs/public/ws-s11b.png differ diff --git a/docs/public/ws-s12a.png b/docs/public/ws-s12a.png new file mode 100644 index 0000000..a640086 Binary files /dev/null and b/docs/public/ws-s12a.png differ diff --git a/docs/public/ws-s12b.png b/docs/public/ws-s12b.png new file mode 100644 index 0000000..72f9693 Binary files /dev/null and b/docs/public/ws-s12b.png differ diff --git a/docs/public/ws-s12c.png b/docs/public/ws-s12c.png new file mode 100644 index 0000000..6b7f63c Binary files /dev/null and b/docs/public/ws-s12c.png differ diff --git a/docs/public/ws-s13a.png b/docs/public/ws-s13a.png new file mode 100644 index 0000000..3a3201c Binary files /dev/null and b/docs/public/ws-s13a.png differ diff --git a/docs/public/ws-s13b.png b/docs/public/ws-s13b.png new file mode 100644 index 0000000..1ed6720 Binary files /dev/null and b/docs/public/ws-s13b.png differ