Skip to content

docs(authentication): document SHORTCAKE_PASSKEY companion linking - #358

Merged
jlucaso1 merged 2 commits into
mainfrom
claude/nifty-bohr-gd9gpl
Jul 1, 2026
Merged

docs(authentication): document SHORTCAKE_PASSKEY companion linking#358
jlucaso1 merged 2 commits into
mainfrom
claude/nifty-bohr-gd9gpl

Conversation

@jlucaso1

@jlucaso1 jlucaso1 commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

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), the PasskeyAuthenticator trait/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 — adds PairPasskeyRequest, PairPasskeyConfirmation, and PairPasskeyError to the Event enum listing and the Pairing Events section.
  • api/client.mdx — documents set_passkey_authenticator, send_passkey_response, and send_passkey_confirmation, including PasskeyError variants.
  • api/wacore.mdx — adds the shortcake module (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.rs source, and the updated wacore/src/types/events.rs to keep struct fields, method signatures, and error variants accurate.

Test plan

  • Mintlify build/preview renders the new sections and mermaid diagram correctly
  • Cross-reference anchors (/concepts/authentication#..., /api/client#...) resolve correctly

Generated 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.

  • New Features
    • 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: Documents PairPasskeyRequest, PairPasskeyConfirmation, PairPasskeyError.
    • api/client.mdx: Adds set_passkey_authenticator, send_passkey_response, send_passkey_confirmation, and PasskeyError variants.
    • api/wacore.mdx: Adds the shortcake module 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.

Review in cubic

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
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jlucaso1, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 18 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

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.

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 configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f2adf80c-022a-449c-85e8-a71717150b2a

📥 Commits

Reviewing files that changed from the base of the PR and between a5e47c0 and 36df5a1.

📒 Files selected for processing (5)
  • api/client.mdx
  • api/wacore.mdx
  • concepts/authentication.mdx
  • concepts/events.mdx
  • introduction.mdx

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.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
whatsapp-rust 🟢 Ready View Preview Jul 1, 2026, 10:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 5 files

Re-trigger cubic

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread concepts/authentication.mdx Outdated
…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
@jlucaso1
jlucaso1 merged commit d61ca84 into main Jul 1, 2026
3 checks passed
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