Update web SDK documentation with new providerVersion options and closeModal method#67
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation for the Web SDK was updated to introduce a new optional Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant WebSDK
Developer->>WebSDK: init({ providerVersion, ... })
Developer->>WebSDK: triggerReclaimFlow()
WebSDK-->>Developer: Show QR code modal (showExtensionInstallButton: false)
Developer->>WebSDK: closeModal()
WebSDK-->>Developer: Modal closed
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
content/docs/advance-options/web-sdk.mdx (1)
494-496: Comment says default: true but the spec below sets the default to falseThe inline comment contradicts the bullet list farther down which states
showExtensionInstallButtondefaults tofalse. Align them to prevent confusion.- showExtensionInstallButton: true, // Show extension install button (default: true) + showExtensionInstallButton: true, // Show extension install button (default: false)
🧹 Nitpick comments (4)
content/docs/advance-options/web-sdk.mdx (4)
26-28: Specify default value forproviderVersionto avoid ambiguityThe other options in this block explicitly document their defaults, but
providerVersiondoes not. Readers may wonder whether the SDK falls back to the latest version, a fixed version, or leaves the value unset.- providerVersion: '1.0.0' + providerVersion: '1.0.0', // default: 'latest'
46-46: Clarify the inline-comment – it currently refers to the entireoptionsobject, notprovider_version
# default: Falsereads as if the default forprovider_versionisFalse, which is misleading. Either delete the comment or scope it tolog.- options={'log': True, 'provider_version': '1.0.0'} # default: False + # Only the `log` flag defaults to False. `provider_version` defaults to 'latest' + options={'log': True, 'provider_version': '1.0.0'}
50-51: Add default information forprovider_versionto mirror the JS sectionEvery other bullet lists a default; adding it here keeps the two language sections aligned.
- - `provider_version`: Version of the data provider. This is needed if you are using a specific version of the data provider. + - `provider_version` (Default: `'latest'`): Version of the data provider. Supply this only when you need a fixed provider build.
517-538: Add brief guidance on when to callcloseModal()Most users will call
triggerReclaimFlow()and wait for a result event; abruptly closing the modal may break the UX if proofs are still being generated. A short note such as “only call after you have handled the proof or on user cancel” would help.No diff supplied as wording is content-dependent.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/docs/advance-options/web-sdk.mdx(3 hunks)
🔇 Additional comments (1)
content/docs/advance-options/web-sdk.mdx (1)
513-513: Default mismatchThis bullet correctly states the default is
false, but it will keep clashing with the example above until that is updated (see previous comment). Make sure both locations stay consistent after editing.
2 participants
Description
Update web SDK documentation with new providerVersion options and closeModal method
Type of change
Checklist:
Summary by CodeRabbit