Skip to content

docs: add WhatsApp Business (Official API) channel (EN/ZH) - #173

Merged
Nanyan merged 1 commit into
mainfrom
docs/wab-channel
Jul 2, 2026
Merged

Nanyan merged 1 commit into
mainfrom
docs/wab-channel

Conversation

@FelixLin6

Copy link
Copy Markdown
Contributor

What

Adds WhatsApp Business (Official API) as a channel across the docs site — channel usage page, deployment guide section, index rows, and sidebar entries, in both English and Chinese.

Why

The WAB channel (zylos-ai/zylos-whatsapp-business + coco-dashboard OTP onboarding wizard) is live-fire tested and being released, but coco-materials has no user-facing documentation for it. This fills that gap so users can connect a WhatsApp Business number from the COCO Dashboard.

Element set mirrors what existing channels have (LINE/Zalo as the most recent precedents) — nothing invented:

Element Files
Channel usage page docs/channels/whatsapp-business.md, docs/zh/channels/whatsapp-business.md
Channels index table row docs/channels/index.md, docs/zh/channels/index.md
Deployment guide section (Option L / 选项M) + supported-channels table row docs/getting-started/channel-deployment.md, docs/zh/getting-started/channel-deployment.md
Sidebar entries docs/.vitepress/config.mjs (EN + ZH)
Cross-link between the two WhatsApp variants notes in existing WhatsApp sections (mirrors the Zalo Official/Personal cross-referencing)

Guide content follows the actual dashboard onboarding wizard: WhatsApp Business card → phone number + display name (with hard-to-change warning) → 6-digit OTP (SMS, voice fallback, mainland-China SMS caveat) → auto-deploy. Documents official-API constraints truthfully: DM-only (no groups), 24-hour customer-service window with template fallback.

No screenshots included yet — can be added in a follow-up once the released dashboard flow is captured (other channels reference images in docs/public/).

Test

  • Tested locally — node --check passes on config.mjs; markdown tables/anchors follow the existing pages' format

Review checklist

  • No secrets or credentials in code
  • Changes match the PR title
  • Breaking changes documented (if any) — none

🤖 Generated with Claude Code

…ployment guide (EN/ZH)

Adds the WhatsApp Business Cloud API channel to the docs site, mirroring
the element set of existing channels (LINE/Zalo precedent):

- docs/channels/whatsapp-business.md + zh counterpart (usage tips page)
- Row in channels index table (EN/ZH)
- Option L / 选项M deployment section + supported-channels table row (EN/ZH)
- VitePress sidebar entries (EN/ZH)
- Cross-link notes between WhatsApp (QR) and WhatsApp Business (official API)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@Nanyan Nanyan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. 文档结构完整,内容准确:

  • EN/ZH 双语齐全,翻译自然
  • 与现有 WhatsApp(QR 扫码)渠道的区分说明清晰
  • 部署步骤准确反映了实际的 Dashboard 向导流程(号码 → 显示名称 → OTP → 自动部署)
  • 正确记录了官方 API 约束(仅 1:1 私信、24 小时窗口、模板消息)
  • FAQ/故障排除表实用(+86 短信不稳定、号码已注册等)
  • sidebar/index/deployment guide 各处交叉引用一致

小 note:EN 用 Option L,ZH 用选项M,字母不同但 anchor {#whatsapp-business} 一致,链接不受影响。

@Nanyan
Nanyan merged commit 58ded3a into main Jul 2, 2026
3 checks passed
@Nanyan
Nanyan deleted the docs/wab-channel branch July 2, 2026 18:06
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.

2 participants