Mintlify/2fc4af51

[purpshell]

Summary by CodeRabbit

• Documentation
  • Added guides for handling WhatsApp calls, synchronizing chat history, and the USync protocol
  • New FAQ page addressing common questions about connections, messages, authentication, and features
  • New migration guides for upgrading to versions 7 and 8
  • New community documentation for contributions, sponsorships, and translations
  • Updated authentication guides with revised examples

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 06bd9f46-cd83-449d-83d4-8444a80fe827

📥 Commits

Reviewing files that changed from the base of the PR and between 521886d and 83abd9e.

📒 Files selected for processing (18)

• .pr-body.md
• advanced/calls.mdx
• advanced/history-sync.mdx
• advanced/troubleshooting.mdx
• advanced/usync.mdx
• authentication/pairing-code.mdx
• authentication/qr-code.mdx
• authentication/session-management.mdx
• community/contributing.mdx
• community/sponsor.mdx
• community/translations.mdx
• docs.json
• faq.mdx
• index.mdx
• messaging/message-actions.mdx
• migration/v7.mdx
• migration/v8.mdx
• quickstart.mdx

---

📝 Walkthrough

Walkthrough

This PR expands the Baileys documentation with new pages (FAQ, migration guides for v7/v8, advanced topics), adds community contribution pages, and deprecates the printQRInTerminal option across authentication examples, replacing it with explicit qrcode-terminal rendering via event handlers.

Changes

Documentation Expansion and QR Deprecation

Layer / File(s)	Summary
Navigation Structure docs.json	Documentation navigation updated to add FAQ under Get Started; Advanced group reordered to include new history-sync, usync, and calls pages; Migration and Community groups added.
Advanced Topics advanced/calls.mdx, advanced/history-sync.mdx, advanced/usync.mdx	New advanced documentation pages: calls explains listening to call events and rejecting offers via rejectCall(); history-sync describes messaging-history.set event handling and full-history sync configuration; usync documents the USync protocol for identity resolution and lookups.
Migration Guides migration/v7.mdx, migration/v8.mdx	New migration documentation: v7 covers LID migration, ACK removal, ESM-only requirement, and protobuf changes; v8 outlines class-based architecture, whatsmeow integration foundation, and new authentication requiring one-time migration helper.
Community Pages community/contributing.mdx, community/sponsor.mdx, community/translations.mdx	New community documentation: contributing explains code/docs workflow and code of conduct; sponsor describes sponsorship perks and alternative support methods; translations lists priority languages and contribution process.
FAQ faq.mdx	New FAQ page addressing connection behavior, QR rendering, message retry, auth practices, LID migration, rate limits, versioning, Mobile API support, and where to report issues.
QR Code Deprecation Pattern authentication/qr-code.mdx	Primary example showing printQRInTerminal deprecation: rewritten to import qrcode-terminal, listen for connection.update with qr field, and render via qrcode.generate() instead of using socket option.
Quick Start Updates index.mdx, quickstart.mdx	Install step adds qrcode-terminal alongside Baileys; authentication examples updated to import qrcode-terminal, create socket with auth: state only, and render QR in connection.update handler.
Other Auth Pages authentication/pairing-code.mdx, authentication/session-management.mdx, advanced/troubleshooting.mdx	Removed printQRInTerminal option from socket configurations and updated guidance to show event-driven QR handling; pairing-code emphasizes ignoring qr field in that context.
Refactoring & Metadata .pr-body.md, messaging/message-actions.mdx	PR body documents wiki ingestion and deprecation scope; message-actions page moved call rejection instructions to new dedicated calls page via cross-reference link.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hop! Hop! New docs take flight,
FAQ and guides all shining bright,
QR codes dance in terminal light,
Community paths opened wide—
Baileys docs bloom with springtime pride! 🌱

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch mintlify/2fc4af51

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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