Skip to content

docs(whatsapp): rewrite for Baileys bridge implementation#49

Open
vanducng wants to merge 4 commits intomasterfrom
docs/whatsapp-channel-update
Open

docs(whatsapp): rewrite for Baileys bridge implementation#49
vanducng wants to merge 4 commits intomasterfrom
docs/whatsapp-channel-update

Conversation

@vanducng
Copy link
Copy Markdown
Contributor

@vanducng vanducng commented Apr 6, 2026

Summary

Rewrites WhatsApp channel documentation to match the actual Baileys bridge implementation from nextlevelbuilder/goclaw#720.

  • Setup: Docker Compose quick start + manual bridge instructions (replaces placeholder whatsapp-web.js docs)
  • QR auth: Documented the full QR code authentication flow (bridge→GoClaw→UI wizard)
  • Media: Inbound + outbound media via shared Docker volume
  • Formatting: Markdown→WhatsApp native conversion table
  • Bridge protocol: Full JSON message reference (Bridge↔GoClaw)
  • Config: Correct defaults (pairing not open), new require_mention field
  • Troubleshooting: Added format mismatch issue from #703 + 7 other common problems
  • INDEX.md: Updated comparison tables across all 3 locales (media, auth, complexity)
  • i18n: All 3 locales updated (en, vi, zh)

Test plan

  • Verify Mermaid diagram renders on docs site
  • Verify all internal links resolve
  • Cross-check config fields against internal/config/config_channels.go

vanducng added 2 commits April 6, 2026 13:18
…ementation

- Replace placeholder whatsapp-web.js docs with actual Baileys bridge setup
- Add QR code authentication flow, media support, typing indicators
- Document bridge protocol (Bridge↔GoClaw JSON messages)
- Add Docker Compose quick start and manual setup instructions
- Add config reference with correct defaults (pairing, not open)
- Add formatting table (Markdown→WhatsApp native conversion)
- Add troubleshooting for common issues (#703: format mismatch)
- Update INDEX.md comparison tables (media, auth method, complexity)
- Update setup checklists across all 3 locales (en, vi, zh)
- Remove external service references from setup, config, and architecture
- Simplify setup to 3 steps (create channel, scan QR, configure policies)
- Update architecture diagram to show direct connection
- Add migration section for users on the old setup
- Add history_limit config, LID addressing section
- Fix inline code formatting row in conversion table
- Simplify setup checklist in INDEX.md
- All 3 locales updated (en, vi, zh)
@vanducng vanducng marked this pull request as ready for review April 6, 2026 12:03
vanducng added 2 commits April 7, 2026 00:05
…, env vars

- configuration.md: replace bridge_url with new config fields (require_mention, history_limit)
- config-reference.md: expand WhatsApp table with full field list
- environment-variables.md: replace BRIDGE_URL with ENABLED
- troubleshooting/channels.md: rewrite WhatsApp section for native connection
- All 3 locales updated (en, vi, zh)
…tion" wording

Replace "Native (whatsmeow)" with "Direct connection" across all 3 locales
(INDEX.md + whatsapp.md). Remove implementation-specific library details from
user-facing docs — library names belong in code comments, not documentation.
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.

1 participant