docs(authentication): document SHORTCAKE_PASSKEY companion linking - #358
Conversation
Adds a full passkey/WebAuthn linking section to authentication docs (PasskeyAuthenticator, driving modes, re-link handoff), the three new PairPasskey* events, and the corresponding Client methods and wacore shortcake module reference. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017SWznhk7WVYsqTwW8vGGmQ
|
Warning Review limit reached
Next review available in: 18 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
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. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 795268caf8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…irmation Automatic mode only auto-confirms proven re-links (skip_handoff_ux); a fresh link still needs the host to call send_passkey_confirmation() after the user approves the code, in both automatic and manual mode. Addresses Codex review feedback on PR #358. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017SWznhk7WVYsqTwW8vGGmQ
Summary
Documents the new passkey (SHORTCAKE_PASSKEY) companion-linking flow added in whatsapp-rust#928, the third authentication method alongside QR code and pair code linking.
concepts/authentication.mdx— new "Passkey linking (SHORTCAKE_PASSKEY)" section: how the flow works (mermaid sequence diagram), thePasskeyAuthenticatortrait/seam, automatic vs. manual driving modes, re-link handoff (skip_handoff_ux), events, and client methods. Overview updated from two to three methods.concepts/events.mdx— addsPairPasskeyRequest,PairPasskeyConfirmation, andPairPasskeyErrorto theEventenum listing and the Pairing Events section.api/client.mdx— documentsset_passkey_authenticator,send_passkey_response, andsend_passkey_confirmation, includingPasskeyErrorvariants.api/wacore.mdx— adds theshortcakemodule (pure crypto/protobuf core) to the Connection & Pairing module list.introduction.mdx— adds a passkey linking bullet to the Authentication feature list.Content was written after reading the merged PR's diff, the new
wacore/src/shortcake.rs/src/passkey/mod.rs/src/passkey/flow.rssource, and the updatedwacore/src/types/events.rsto keep struct fields, method signatures, and error variants accurate.Test plan
/concepts/authentication#...,/api/client#...) resolve correctlyGenerated by Claude Code
Summary by cubic
Adds docs for passkey linking (SHORTCAKE_PASSKEY) as the third authentication option, covering the flow, events, and client API. Clarifies that automatic mode only auto-confirms proven re-links; fresh links still require manual confirmation after showing the code.
concepts/authentication.mdx: Passkey linking section with flow,PasskeyAuthenticator, auto/manual modes, re-link handoff, explicit note that fresh links need manual confirmation, events, and client calls.concepts/events.mdx: DocumentsPairPasskeyRequest,PairPasskeyConfirmation,PairPasskeyError.api/client.mdx: Addsset_passkey_authenticator,send_passkey_response,send_passkey_confirmation, andPasskeyErrorvariants.api/wacore.mdx: Adds theshortcakemodule description and link to auth docs.introduction.mdx: Adds passkey linking to the feature list.Written for commit 36df5a1. Summary will update on new commits.