Add introduction, backend verification docs to the inapp/ documentation
#49
Conversation
predatorx7
added
documentation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis update restructures and expands the documentation for Reclaim Protocol's InApp SDKs. It introduces new sections, reorganizes existing content, adds guides for backend verification and Flutter integration, and updates metadata files for improved navigation. Several document titles and links are standardized, while outdated or redundant files are removed. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite
participant Backend
participant MobileApp
User->>DocsSite: Navigates to InApp SDKs documentation
DocsSite-->>User: Shows introduction, installation, verification, advanced guides
User->>DocsSite: Views Flutter/Platform integration guide
DocsSite-->>User: Presents setup, usage, and configuration details
User->>DocsSite: Views backend verification guide
DocsSite-->>User: Shows backend and client code samples
User->>MobileApp: Starts verification (per guide)
MobileApp->>Backend: Sends/receives verification requests and proofs
Backend-->>MobileApp: Returns verification result
MobileApp-->>User: Displays verification outcome
Suggested reviewers
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (
|
|
Will fix verbose sentences and move troubleshooting to another page |
predatorx7
changed the title
inapp/ documentationinapp/ documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🔭 Outside diff range comments (1)
content/docs/backend/installation.mdx (1)
65-65: 🛠️ Refactor suggestionCorrect the pip show command for Python SDK.
The commandpip show reclaim-sdkwill not locate thereclaim-python-sdkpackage. Update it to:pip show reclaim-python-sdk
🧹 Nitpick comments (9)
content/docs/inapp-sdks/installation/android.mdx (1)
164-164: Refine the relative link path: Consider simplifying./../advanced/overridesto../advanced/overridesfor consistency with other pages and to avoid the redundant./.content/docs/backend/installation.mdx (1)
3-3: Align frontmatter description with content coverage.
The description currently reads “integrating Reclaim Protocol into your Node.js backend project” but the guide covers both JavaScript and Python backends. Consider generalizing to “backend project” to avoid confusion.content/docs/inapp-sdks/installation/react-native-expo.mdx (1)
2-6: Ensure frontmatter title and heading match.
The frontmatter title is “React Native Expo” but the H1 is “React Native Expo SDK.” For consistency, remove “SDK” from the H1 or adjust the title.content/docs/inapp-sdks/advanced/intro.mdx (1)
2-6: Sync frontmatter title with page heading.
Thetitlein the frontmatter is “Usage” while the H1 is “More about Reclaim InApp SDKs.” Consider making these consistent to avoid confusing readers.content/docs/inapp-sdks/advanced/verification-options.mdx (1)
6-8: Remove unused imports
TheTabs,Tab,Accordion, andAccordionscomponents are imported but not used in this document. Please remove these imports or implement them (e.g., wrap the options table in an accordion or tabs if intended).content/docs/inapp-sdks/introduction.mdx (2)
1-4: Fix subject–verb agreement and article usage
Change “The InApp SDKs enables seamless in-app verification experience” to “The InApp SDKs enable a seamless in-app verification experience”.
37-42: Polish tone and capitalization
- Replace “Please feel free to file feature requests and bugs at the issue tracker of InApp sdks.” with “Please file feature requests and bugs in the InApp SDKs issue tracker.”
- Remove the “;)” emoticon for a more professional tone.
🧰 Tools
🪛 LanguageTool
[style] ~37-~37: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ontributing Contributions are welcome! Please feel free to submit a Pull Request. ### Issues and ...(FEEL_FREE_TO_STYLE_ME)
[style] ~40-~40: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...Pull Request. ### Issues and Feedback Please feel free to file feature requests and bugs at the i...(FEEL_FREE_TO_STYLE_ME)
content/docs/inapp-sdks/verification.mdx (1)
17-21: Consider hyperlinking key domains
Linkdev.reclaimprotocol.orgin the bullet points tohttps://dev.reclaimprotocol.orgfor quick access.content/docs/inapp-sdks/installation/flutter.mdx (1)
30-35: Specify version placeholder
Indicating^latest_versionmay confuse readers. Suggest replacing with an actual version or a note to replace it, e.g.:- reclaim_inapp_flutter_sdk: ^latest_version + reclaim_inapp_flutter_sdk: ^1.0.0 # replace with the latest released version
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
public/assets/inapp/inapp_demo.mp4is excluded by!**/*.mp4
📒 Files selected for processing (16)
content/docs/backend/installation.mdx(1 hunks)content/docs/inapp-sdks/advanced/intro.mdx(1 hunks)content/docs/inapp-sdks/advanced/meta.json(1 hunks)content/docs/inapp-sdks/advanced/verification-options.mdx(1 hunks)content/docs/inapp-sdks/flutter.mdx(0 hunks)content/docs/inapp-sdks/installation/android.mdx(2 hunks)content/docs/inapp-sdks/installation/flutter.mdx(1 hunks)content/docs/inapp-sdks/installation/ionic-capacitor.mdx(2 hunks)content/docs/inapp-sdks/installation/ios.mdx(2 hunks)content/docs/inapp-sdks/installation/meta.json(1 hunks)content/docs/inapp-sdks/installation/react-native-expo.mdx(1 hunks)content/docs/inapp-sdks/installation/react-native.mdx(2 hunks)content/docs/inapp-sdks/introduction.mdx(1 hunks)content/docs/inapp-sdks/meta.json(1 hunks)content/docs/inapp-sdks/verification.mdx(1 hunks)package.json(1 hunks)
💤 Files with no reviewable changes (1)
- content/docs/inapp-sdks/flutter.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/inapp-sdks/installation/ios.mdx
[typographical] ~322-~322: Ikke parret symbol: "]" ser ud til at mangle
Context: ... } } ``` Read more about overrides in [Reclaim InApp SDK Documentation | Overri...
(UNPAIRED_BRACKETS)
content/docs/inapp-sdks/introduction.mdx
[uncategorized] ~7-~7: You might be missing the article “the” here.
Context: ...to leave your app! --- ## Integration Following is an example on how we used the [Githu...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~8-~8: The preposition “of” seems more likely in this position.
Context: ...## Integration Following is an example on how we used the [Github Username Provid...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[grammar] ~20-~20: This phrase is duplicated. You should probably use “React Native” only once.
Context: ...android) * iOS * React Native * React Native Expo...
(PHRASE_REPETITION)
[style] ~37-~37: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ontributing Contributions are welcome! Please feel free to submit a Pull Request. ### Issues and ...
(FEEL_FREE_TO_STYLE_ME)
[style] ~40-~40: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...Pull Request. ### Issues and Feedback Please feel free to file feature requests and bugs at the i...
(FEEL_FREE_TO_STYLE_ME)
content/docs/inapp-sdks/verification.mdx
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...it. - Get the request_urlby callinggetRequestUrl` method on proof request o...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~102-~102: Possible missing article found.
Context: ...bs> ### 5. Verify proofs at backend - Mobile application (client) should send the pr...
(AI_HYDRA_LEO_MISSING_THE)
content/docs/inapp-sdks/installation/flutter.mdx
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ...pports the following options: - appId: Your Reclaim application ID - `provider...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~127-~127: Loose punctuation mark.
Context: ...owing environment variables: - APP_ID: Your Reclaim application ID - `APP_SECR...
(UNLIKELY_OPENING_PUNCTUATION)
🔇 Additional comments (20)
content/docs/inapp-sdks/advanced/meta.json (1)
5-5: Addition ofverification-optionspage: The inclusion of"verification-options"between"intro"and"attestor-auth"correctly reflects the new advanced verification options content in the documentation hierarchy.content/docs/inapp-sdks/installation/ios.mdx (2)
2-2: Update title from "iOS SDK" to "iOS": This correctly aligns with the new documentation structure, concisely naming the installation page.
322-322: Validate the overrides link: The link to[Overrides](../advanced/overrides)points to the advanced overrides page. Ensure the relative path../advanced/overridesresolves correctly frominstallation/ios.mdx.🧰 Tools
🪛 LanguageTool
[typographical] ~322-~322: Ikke parret symbol: "]" ser ud til at mangle
Context: ... } } ``` Read more about overrides in [Reclaim InApp SDK Documentation | Overri...(UNPAIRED_BRACKETS)
content/docs/inapp-sdks/installation/ionic-capacitor.mdx (2)
2-2: Standardize page title to "Ionic - Capacitor": The updated title removes "SDK" for consistency across installation pages.
394-394: Check overrides documentation link: Confirm that the relative path../advanced/overridesnavigates correctly from this file's location.content/docs/inapp-sdks/installation/android.mdx (1)
2-2: Rename "Android SDK" to "Android": The title change improves consistency with other platforms, removing the redundant "SDK".content/docs/inapp-sdks/installation/react-native.mdx (2)
2-2: Update page title to "React Native": Consistent with the new naming convention across installation guides, dropping "SDK".
346-346: Verify overrides link path: The link../advanced/overridesshould resolve correctly frominstallation/react-native.mdx.content/docs/inapp-sdks/installation/meta.json (1)
1-11: Validate installation section metadata.
The newmeta.jsonaccurately defines the “Installation” section and lists all platform pages in the intended order.content/docs/inapp-sdks/meta.json (1)
1-9: Approve InApp SDKs navigation restructure.
The updated JSON correctly reorganizes the InApp SDK docs into conceptual sections (“introduction”, “installation”, “verification”, “advanced”).content/docs/inapp-sdks/advanced/verification-options.mdx (2)
1-4: Front matter looks good
The title and description are clear and correctly formatted in MDX front matter.
9-17: Options API table is clear
The table layout is concise, and each prop is well-documented. No issues found here.content/docs/inapp-sdks/introduction.mdx (2)
18-24: Platform installation links are consistent
The list of platform-specific installation pages is well-organized and uses correct relative links.🧰 Tools
🪛 LanguageTool
[grammar] ~20-~20: This phrase is duplicated. You should probably use “React Native” only once.
Context: ...android) * iOS * React Native * React Native Expo...(PHRASE_REPETITION)
25-34: Verification and advanced usage section is clear
The links to backend verification and advanced usage docs are accurate and helpful.content/docs/inapp-sdks/verification.mdx (4)
1-4: Front matter is correct
Title and description properly declared.
27-41: Server-side code snippet is clear
Error handling and return codes are appropriate.
44-98: Client-side tabs and code examples are well-structured
Usage of<Tabs>and<Tab>components is correct, and sample code across Swift, Kotlin, and JavaScript is clear.
100-122: Backend verification snippet is accurate
The final snippet forverifyProofis straightforward and includes proper error handling.🧰 Tools
🪛 LanguageTool
[uncategorized] ~102-~102: Possible missing article found.
Context: ...bs> ### 5. Verify proofs at backend - Mobile application (client) should send the pr...(AI_HYDRA_LEO_MISSING_THE)
content/docs/inapp-sdks/installation/flutter.mdx (1)
119-123: Example link path
Verify that the[example](example/lib/main.dart)path resolves correctly in the deployed docs. Consider using a relative path from the root of this section.package.json (1)
38-40:✅ Verification successful
Validate the
packageManagerchecksum for reproducible installs
Adding the"packageManager": "pnpm@10.10.0+sha512.…"field is a great step toward locking down dependency tooling. Please confirm that the embedded SHA-512 checksum matches the official pnpm v10.10.0 tarball to avoid install-time mismatches.You can verify with:
and compare the result against the checksum in your field.
🏁 Script executed:
curl -fsSL "https://registry.npmjs.org/pnpm/-/pnpm-10.10.0.tgz" | shasum -a 512Length of output: 225
🏁 Script executed:
#!/bin/bash # Compute the SHA-512 checksum for pnpm v10.10.0 tarball curl -fsSL "https://registry.npmjs.org/pnpm/-/pnpm-10.10.0.tgz" | sha512sum | awk '{print $1}'Length of output: 243
🏁 Script executed:
#!/bin/bash # Compute SHA-512 checksum using Python curl -fsSL "https://registry.npmjs.org/pnpm/-/pnpm-10.10.0.tgz" | python3 - << 'EOF' import hashlib, sys data = sys.stdin.buffer.read() print(hashlib.sha512(data).hexdigest()) EOFLength of output: 253
🏁 Script executed:
#!/bin/bash # Correctly compute the SHA-512 checksum for pnpm v10.10.0 tarball using Python -c curl -fsSL "https://registry.npmjs.org/pnpm/-/pnpm-10.10.0.tgz" \ | python3 -c 'import hashlib,sys; print(hashlib.sha512(sys.stdin.buffer.read()).hexdigest())'Length of output: 286
Checksum Verified Successfully
The SHA-512 checksum inpackage.jsonmatches the official pnpm v10.10.0 tarball (d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39). No further changes required.
| Following is an example on how we used the [Github Username Provider](https://dev.reclaimprotocol.org/provider/6d3f6753-7ee6-49ee-a545-62f1b1822ae5) with the InApp SDK in an ios native application to verify Github account ownership. | ||
|
|
||
| <video src="/assets/inapp/inapp_demo.mp4" alt="Using InApp SDK to verify Github ownership" width="400px" type="video/mp4" controls></video> | ||
|
|
There was a problem hiding this comment.
Correct grammar and capitalization
Update “Following is an example on how we used the [Github Username Provider] with the InApp SDK in an ios native application to verify Github account ownership.” to:
-Following is an example on how we used the [Github Username Provider] with the InApp SDK in an ios native application to verify Github account ownership.
+Here’s an example of how we used the [GitHub Username Provider] with the InApp SDK in an iOS native application to verify GitHub account ownership.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Following is an example on how we used the [Github Username Provider](https://dev.reclaimprotocol.org/provider/6d3f6753-7ee6-49ee-a545-62f1b1822ae5) with the InApp SDK in an ios native application to verify Github account ownership. | |
| <video src="/assets/inapp/inapp_demo.mp4" alt="Using InApp SDK to verify Github ownership" width="400px" type="video/mp4" controls></video> | |
| Here’s an example of how we used the [GitHub Username Provider](https://dev.reclaimprotocol.org/provider/6d3f6753-7ee6-49ee-a545-62f1b1822ae5) with the InApp SDK in an iOS native application to verify GitHub account ownership. | |
| <video src="/assets/inapp/inapp_demo.mp4" alt="Using InApp SDK to verify Github ownership" width="400px" type="video/mp4" controls></video> |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: The preposition “of” seems more likely in this position.
Context: ...## Integration Following is an example on how we used the [Github Username Provid...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
| import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; | ||
|
|
||
| As best practice, we **strongly** recommend verifying proofs generated from client-side SDKs with a [Reclaim Protocol Backend SDK](http://localhost:3000/backend/installation). | ||
|
|
||
| ## Step-by-Step Guide | ||
|
|
||
| ### 1. Install the SDK | ||
|
|
||
| Make sure you have installed the SDKs by following the instructions on the [Installation page](./../backend/installation). |
There was a problem hiding this comment.
Update internal link instead of localhost URL
The link in line 8 points to http://localhost:3000/backend/installation. It should use the same relative path as in line 14:
-[As best practice, we **strongly** recommend verifying proofs generated from client-side SDKs with a [Reclaim Protocol Backend SDK](http://localhost:3000/backend/installation).]
+As a best practice, **strongly** recommend verifying proofs generated from client-side SDKs with a [Reclaim Protocol Backend SDK](./../backend/installation).Committable suggestion skipped: line range outside the PR's diff.
| ### Configuration Options | ||
|
|
||
| The `ReclaimVerificationRequest` supports the following options: | ||
|
|
||
| - `appId`: Your Reclaim application ID | ||
| - `providerId`: The ID of the provider you want to verify against | ||
| - `secret`: Your application secret (optional if using session information) | ||
| - `sessionInformation`: Session information for authentication | ||
| - `contextString`: Additional context for the verification | ||
| - `parameters`: Custom parameters for the verification | ||
| - `claimCreationType`: Type of claim creation (standalone or meChain) | ||
| - `autoSubmit`: Whether to auto-submit the verification | ||
| - `hideCloseButton`: Whether to hide the close button | ||
| - `webhookUrl`: URL for webhook notifications | ||
| - `verificationOptions`: Additional verification options | ||
|
|
There was a problem hiding this comment.
Unify option naming across docs
The Flutter guide uses autoSubmit and hideCloseButton, while the advanced docs use canAutoSubmit and isCloseButtonVisible. Please standardize these option names to avoid confusion.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~79-~79: Loose punctuation mark.
Context: ...pports the following options: - appId: Your Reclaim application ID - `provider...
(UNLIKELY_OPENING_PUNCTUATION)
| --- | ||
| title: Flutter | ||
| description: Available upon request - Reclaim Protocol integration for Flutter applications | ||
| --- | ||
|
|
||
| # Get Started | ||
|
|
||
| <Callout type="info"> | ||
| The Reclaim Protocol SDK for Flutter (android & iOS) applications is ready and available upon request. Contact our team to discuss implementation details. | ||
| </Callout> |
There was a problem hiding this comment.
Inconsistent callout vs. content
The callout states the SDK is “available upon request,” but the file then provides full installation and usage instructions. Please remove or revise the callout to reflect that the Flutter SDK is publicly available.
| Following is an exmaple. | ||
|
|
||
| ```dart |
There was a problem hiding this comment.
Fix typo in “example”
Line 50 has “exmaple.” Change to:
-Following is an exmaple.
+Here is an example:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Following is an exmaple. | |
| ```dart | |
| Here is an example: | |
…tion (#49) * Add [WIP] introduction, backend verification docs to the inapp/ documentation * Add documentation for verification options and backend verification * Remove packageManager field from package.json
Description
Updates to inapp sdk installation docs, and addition of introduction and backend verification docs
Testing (ignore for documentation update)
Type of change
Checklist:
Additional Notes:
Summary by CodeRabbit
New Features
Documentation
Chores