Skip to content

docs: Multi-Channel Bot Deployment Documentation#460

Merged
MervinPraison merged 1 commit into
mainfrom
claude/issue-451-20260530-0623
Jun 3, 2026
Merged

docs: Multi-Channel Bot Deployment Documentation#460
MervinPraison merged 1 commit into
mainfrom
claude/issue-451-20260530-0623

Conversation

@MervinPraison
Copy link
Copy Markdown
Owner

Implements comprehensive documentation for multi-channel bot deployments based on PR #1757.

Summary

  • New feature page: docs/features/multi-channel-bots.mdx with complete multi-channel bot setup guide
  • Updated onboard wizard docs: Added multi-channel flow with role-based token naming
  • Enhanced existing docs: Updated 6 files across features, CLI, best practices, and troubleshooting
  • Navigation updated: Added new page to docs.json under Features > Communication & Messaging

Key Features Documented

  • Environment variable convention: PLATFORM__BOT_TOKEN pattern
  • Onboard wizard multi-channel flow: Per-channel role prompts and specialized agents
  • Doctor validation: Complete multi_channel_tokens check documentation
  • Security best practices: Unique token per channel requirements
  • Troubleshooting: Multi-channel failure modes and remediation

Implementation Details

Based on merged PR MervinPraison/PraisonAI#1757 source code:

  • src/praisonai/praisonai/cli/features/onboard.py - Multi-channel wizard implementation
  • src/praisonai/praisonai/cli/features/doctor/checks/bot_checks.py - Validation logic
  • examples/yaml/multi-telegram-hermes-workforce.yaml - Reference configuration

Files Changed

  • New: docs/features/multi-channel-bots.mdx - Primary feature guide
  • Updated: 7 existing documentation files with multi-channel references
  • Navigation: docs.json updated with new page

Follows AGENTS.md standards with Mintlify components, Mermaid diagrams, and copy-paste runnable examples.

Fixes #451

🤖 Generated with Claude Code

- Create comprehensive multi-channel-bots.mdx feature guide with:
  * Hero Mermaid diagram and Quick Start with Steps component
  * Environment variable convention table (PLATFORM_<ROLE>_BOT_TOKEN)
  * Complete bot.yaml examples with specialized agents
  * Validation with praisonai doctor section
  * Best practices with AccordionGroup

- Update onboard.mdx to document new multi-channel wizard flow:
  * Updated hero diagram showing role selection loop
  * Added multi-channel setup section with example flow
  * Updated wizard descriptions for per-channel role prompts

- Update messaging-bots.mdx with same-platform multi-role example
- Update bot-routing.mdx with new Workforce tab showing arbitrary channel keys
- Update doctor.mdx with complete multi_channel_tokens check documentation
- Update bot-security.mdx with unique token per channel security rule
- Update troubleshoot-gateway.mdx with multi-channel failure modes table
- Update docs.json navigation to include new page under Features > Communication & Messaging

Based on PR MervinPraison/PraisonAI#1757 implementation details from:
- src/praisonai/praisonai/cli/features/onboard.py
- src/praisonai/praisonai/cli/features/doctor/checks/bot_checks.py
- examples/yaml/multi-telegram-hermes-workforce.yaml

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 30, 2026 06:31
@qodo-code-review
Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 30, 2026

Warning

Review limit reached

@MervinPraison, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 34 minutes and 49 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 314eb880-4085-445f-b480-34cfdc5587f9

📥 Commits

Reviewing files that changed from the base of the PR and between ad3daba and c6bbe86.

📒 Files selected for processing (8)
  • docs.json
  • docs/best-practices/bot-security.mdx
  • docs/cli/doctor.mdx
  • docs/features/bot-routing.mdx
  • docs/features/messaging-bots.mdx
  • docs/features/multi-channel-bots.mdx
  • docs/features/onboard.mdx
  • docs/guides/troubleshoot-gateway.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-451-20260530-0623

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces comprehensive documentation for configuring, securing, and troubleshooting multi-channel bots (running multiple specialized bots on a single platform with unique tokens). It updates the onboarding wizard guide, security best practices, routing configurations, and details the validation checks performed by praisonai doctor. Feedback is provided regarding an incorrect command syntax in the troubleshooting guide, where a check ID is used directly instead of passing it via the --only flag.

**Validation:**
```bash
# Check multi-channel configuration
praisonai doctor multi_channel_tokens
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The command praisonai doctor multi_channel_tokens is incorrect because multi_channel_tokens is a check ID, not a doctor subcommand or category. To run this specific check, you should use the --only flag.

praisonai doctor --only multi_channel_tokens

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@MervinPraison MervinPraison merged commit 6341f31 into main Jun 3, 2026
18 of 19 checks passed
@MervinPraison MervinPraison deleted the claude/issue-451-20260530-0623 branch June 3, 2026 04:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Multi-Channel Bot Deployments — same-platform multi-bot setup, per-channel token env convention, onboard wizard & doctor check (PR #1757)

2 participants