Browser Extension Docs for JS SDK

[Kushal7788]

Description

Browser Extension Docs for JS SDK

Type of change

• Bug fix
• New feature
• Breaking change
• Documentation update

Checklist:

• I have read and agree to the Code of Conduct.
• I have signed the Contributor License Agreement (CLA).
• I have considered the Security Policy.
• I have self-reviewed and tested my code.
• I have updated documentation as needed.
• I agree to the project's custom license.

Summary by CodeRabbit

• Documentation
  • Updated guides to introduce and prioritize a new streamlined verification flow using triggerReclaimFlow(), which automatically selects the optimal method based on the user's platform.
  • Added documentation for browser extension support and modal customization options.
  • Revised examples and instructions to unify usage across both traditional and streamlined verification flows.
  • Improved clarity and fixed minor typos throughout the documentation.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Jun 3, 2025 7:16am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation was updated to introduce and prioritize a new streamlined verification flow using the triggerReclaimFlow() method in the JavaScript SDK. New options for browser extension support and modal customization were added, and all relevant examples and guides were revised to reflect these changes while retaining traditional methods for advanced use cases.

Changes

File(s)	Change Summary
content/docs/advance-options/advance-options.mdx	Updated to introduce triggerReclaimFlow(), browser extension support (useBrowserExtension, extensionID), modal customization (setModalOptions()), and examples for both traditional and new flows.
content/docs/web/frontend/fullstack.mdx	Reorganized to prioritize streamlined implementation using triggerReclaimFlow(), rewrote React example, moved traditional approach to a separate section, and added modal customization guidance.
content/docs/web/frontend/quickstart.mdx	Expanded to highlight the new streamlined approach with triggerReclaimFlow(), added full React example, described platform-specific behaviors, covered extension availability check and modal customization, and fixed a minor typo in another section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend (React)
    participant ReclaimProofRequest SDK
    participant Browser Extension
    participant Mobile App/Clip

    User->>Frontend (React): Click "Start Verification"
    Frontend (React)->>ReclaimProofRequest SDK: triggerReclaimFlow()
    alt Desktop with Extension
        ReclaimProofRequest SDK->>Browser Extension: Initiate Verification
        Browser Extension-->>ReclaimProofRequest SDK: Verification Result
    else Desktop without Extension
        ReclaimProofRequest SDK->>Frontend (React): Show QR Code Modal
        User->>Mobile App/Clip: Scan QR Code
        Mobile App/Clip-->>ReclaimProofRequest SDK: Verification Result
    else Mobile Device
        ReclaimProofRequest SDK->>Mobile App/Clip: Open App Clip/Deep Link
        Mobile App/Clip-->>ReclaimProofRequest SDK: Verification Result
    end
    ReclaimProofRequest SDK-->>Frontend (React): Success/Error Callback
    Frontend (React)-->>User: Show Result

Loading

Suggested labels

documentation, enhancement

Poem

In docs anew the flows align,
With triggers swift and options fine.
Extensions checked, the modals glow,
QR or clip—the proof will show.
Old ways remain, but bunnies cheer,
For streamlined hops are finally here!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 696756f and d41423b.

📒 Files selected for processing (3)

• content/docs/advance-options/advance-options.mdx (11 hunks)
• content/docs/web/frontend/fullstack.mdx (1 hunks)
• content/docs/web/frontend/quickstart.mdx (3 hunks)

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.