removing unecessary docs and ai slop #82
Conversation
|
madhavanmalolan seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds a comprehensive CLAUDE.md reference and reorganizes JS SDK docs into prepare/generate/verify pages; removes many advanced, OAuth, attestor-decentralization, social API, and multiple web/backend/frontend docs; updates mobile SDK installation/usage pages and several meta.json entries. No functional code changes. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Backend as Server (optional)
participant Frontend as Browser / App
participant JS_SDK as `@reclaimprotocol/js-sdk`
participant Verifier as Verifier Backend
Dev->>Backend: create/serve serialized proofRequest (prepare)
Frontend->>JS_SDK: load proofRequest (from backend or inline)
JS_SDK->>Frontend: triggerReclaimFlow / getRequestUrl (generate)
Frontend->>User: show modal / QR / redirect
User->>Verifier: complete verification in app (mobile)
Verifier->>Frontend: callback to appCallbackUrl (proof payload)
Frontend->>Backend: POST proof payload (optional)
Backend->>Verifier: verifyProof(...) (verify)
Verifier-->>Backend: verification result
Backend-->>Frontend: final result / extracted data
Note right of JS_SDK: (colors: new pages highlight) preparing → generating → verifying phases
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60–90 minutes Areas needing extra attention:
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR is being reviewed by Cursor Bugbot
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
| Following is an example of how to handle the exception using [error.type]: | ||
| import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; | ||
| import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; |
There was a problem hiding this comment.
Bug: Imports must appear at top of MDX files
Import statements for UI components (Tab, Tabs, Accordion, Accordions) are placed in the middle of the document content (after line 41) rather than at the top of the file where imports should be. In MDX files, imports must be at the beginning of the file before any content. This will cause a compilation error.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (9)
content/docs/react-native/installation.mdx (1)
76-82: Consider conciseness for "In the meantime" (line 82).The phrase "In the meantime" can be tightened. Consider alternatives like "Meanwhile" or restructuring the sentence to be more direct.
Example:
- Our team is investigating this issue to find a solution. In the meantime, we recommend temporarily removing expo-dev-client from your project when you need to test or use ReclaimInAppSdk functionality on iOS. + Our team is investigating this issue to find a solution. For now, we recommend temporarily removing expo-dev-client from your project when testing or using ReclaimInAppSdk on iOS.content/docs/index.mdx (1)
24-24: Reduce repetitive phrasing in use case bullets.Lines 21-24 begin with "if you need to..." which is used multiple times in succession. Consider varying the sentence structure or using bullet points without the prefix to improve readability.
Example revision:
- **Education Verification** - if you want to verify where and what the student is studying. Useful for marketing campaigns and background verifications. - **Employment Verification** - If you need to make sure the user works where they claim to work. Useful for lending and hiring. - **Financial Background** - if you need to verify financial background like credit score, accredited investor status etc. Particularly useful in lending and credit. - **Shopping History** - if you need to give deals and discounts based on users' loyalty to certain brands + **Education Verification** - Verify where and what students are studying. Useful for marketing campaigns and background verifications. + **Employment Verification** - Confirm employment claims before hiring or lending decisions. + **Financial Background** - Verify credit scores, accredited investor status, and financial metrics for lending and credit decisions. + **Shopping History** - Offer deals and discounts based on users' brand loyalty.CLAUDE.md (2)
154-157: iOS Performance Fix section lacks clarity and explanation.Lines 154-157 mention adding environment variables to resolve a performance issue, but provide no context about:
- What the performance issue is
- Why this specific
GODEBUGsetting fixes it- When/if this is still necessary for current iOS SDK versions
Consider expanding this section with a brief explanation or linking to an issue/discussion.
319-325: Security section is a good start but potentially incomplete.The 5-point security checklist is solid, but consider adding:
- Guidance on CORS/cross-origin considerations
- Rate limiting and DDoS protection
- Logging and audit trail requirements
- Secrets rotation frequency and procedures
- Recovery steps if credentials are compromised
content/docs/api-key.mdx (1)
22-27: Address repeated sentence openers for improved readability.The LanguageTool analysis correctly identifies that lines 25–26 have successive sentences beginning with "You" ("You will be prompted...", "You can always..."). Consider rewording for better variety:
- You will be prompted to add providers when creating the application. You can always go back to your application and add more providers. + Providers can be configured during application creation. You can always go back and add more providers later.content/docs/js-sdk/verifying-proofs.mdx (1)
44-46: Address TODO placeholder in Sanity Check section.Line 45 contains a
TODOplaceholder. This section should either be implemented or removed before release. Clarify the intended content or remove the section.Would you like me to generate a sanity check implementation, or should this section be removed/deferred to a follow-up?
content/docs/js-sdk/generating-proof.mdx (2)
12-27: Apply style corrections for formal tone and date formatting.LanguageTool flags several style issues. Apply these corrections:
- ## User is on a desktop - Till January 31 2026, the proofs can generate a proof only using a mobile device. If the user opens your webapp on a desktop, they should be presented a QR code that they can scan with their iOS or Android device. Once they scan this QR code, they will be directed through the flow as mentioned below. + ## User is on a desktop + Until January 31 2026, proofs can only be generated on mobile devices. If the user opens your webapp on a desktop, they should be presented with a QR code to scan on their iOS or Android device. Once scanned, they will be directed through the flow as described below. - ## January 31 2026 onwards - On January 31, the Reclaim Protocol Embedded SDK is marked for public release. + ## January 31, 2026 onwards + On January 31, the Reclaim Protocol Embedded SDK is marked for public release.
140-153: Refactor repetitive phrasing in redirect section.The phrase "you want to" appears twice in close succession. Consider rewording for variety:
- When you should use this : - - User is on a desktop, scans QR code to generate the proof. After the proof generation is complete you want to show a custom success message on their mobile device instead of the Reclaim Protocol's default success message. You can redirect them to a webpage. - - User is on a mobile, taps a button to generate the proof. After the proof generation is complete, you typically want to redirect the user to the page that must be shown after the proof generation is complete. If you are using `onSuccess`, the user will have to close the proof generation success banner and go back to the browser to continue. We recommend using a redirect url to take the user to the next step in the business logic. On this step, render a page depending on whether the proof was correctly verified. + When you should use this: + - Desktop flow: After QR scan and proof generation, display a custom success message on the user's mobile device instead of the default message by redirecting them to a webpage. + - Mobile flow: After proof generation, redirect the user to the next step in your business logic. Without a redirect URL, users must close the success banner and manually return to the browser. We recommend using a redirect URL to streamline the experience.content/docs/react-native/usage.mdx (1)
45-255: Consider scope of the Advanced Options section for this PR.The new "Advanced options: Overrides" section adds ~210 lines of detailed documentation, including a complete Prisma schema definition (lines 96-185). While comprehensive, this volume of technical detail conflicts with the PR goal of "removing unnecessary docs and ai slop."
Questions for alignment:
- Is the full Prisma schema necessary in SDK usage documentation, or would a link to separate API/schema reference be more appropriate?
- Could this advanced section be deferred to a dedicated reference page to keep usage documentation focused on common use cases?
- Does this detailed schema documentation exist elsewhere or is it new content?
If this content is essential for the PR, consider whether it could be condensed or moved to a dedicated page to maintain documentation focus.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (63)
CLAUDE.md(1 hunks)content/docs/advance-options/attestor-auth.mdx(0 hunks)content/docs/advance-options/js-injections/index.mdx(0 hunks)content/docs/advance-options/js-injections/large-payload.mdx(0 hunks)content/docs/advance-options/js-injections/meta.json(0 hunks)content/docs/advance-options/js-injections/programmatic-navigation.mdx(0 hunks)content/docs/advance-options/js-injections/security-risks.mdx(0 hunks)content/docs/advance-options/js-injections/verification-options.mdx(0 hunks)content/docs/advance-options/meta.json(0 hunks)content/docs/advance-options/overrides.mdx(0 hunks)content/docs/advance-options/verification-options.mdx(0 hunks)content/docs/advance-options/verification.mdx(0 hunks)content/docs/advance-options/web-sdk.mdx(0 hunks)content/docs/ai-agent/index.mdx(0 hunks)content/docs/ai-agent/meta.json(0 hunks)content/docs/ai-agent/quickstart.mdx(0 hunks)content/docs/android-kotlin/installation.mdx(1 hunks)content/docs/android-kotlin/usage.mdx(3 hunks)content/docs/api-key.mdx(2 hunks)content/docs/apis/linkedin.mdx(0 hunks)content/docs/apis/meta.json(0 hunks)content/docs/apis/x.mdx(0 hunks)content/docs/attestor-decentralization/attestor-contracts.mdx(0 hunks)content/docs/attestor-decentralization/index.mdx(0 hunks)content/docs/attestor-decentralization/local-development.mdx(0 hunks)content/docs/attestor-decentralization/meta.json(0 hunks)content/docs/flutter/installation.mdx(0 hunks)content/docs/flutter/usage.mdx(3 hunks)content/docs/index.mdx(1 hunks)content/docs/ionic/installation.mdx(0 hunks)content/docs/ionic/meta.json(0 hunks)content/docs/ionic/usage.mdx(0 hunks)content/docs/ios-swift/installation.mdx(0 hunks)content/docs/ios-swift/usage.mdx(1 hunks)content/docs/js-sdk/generating-proof.mdx(1 hunks)content/docs/js-sdk/index.mdx(0 hunks)content/docs/js-sdk/installation.mdx(2 hunks)content/docs/js-sdk/meta.json(1 hunks)content/docs/js-sdk/preparing-request.mdx(1 hunks)content/docs/js-sdk/verifying-proofs.mdx(1 hunks)content/docs/meta.json(0 hunks)content/docs/oauth/js/index.mdx(0 hunks)content/docs/oauth/js/quickstart.mdx(0 hunks)content/docs/oauth/meta.json(0 hunks)content/docs/oauth/react/api.mdx(0 hunks)content/docs/oauth/react/error-handling.mdx(0 hunks)content/docs/oauth/react/full-setup.mdx(0 hunks)content/docs/oauth/react/hooks.mdx(0 hunks)content/docs/oauth/react/index.mdx(0 hunks)content/docs/oauth/react/quickstart.mdx(0 hunks)content/docs/react-native/installation.mdx(1 hunks)content/docs/react-native/usage.mdx(1 hunks)content/docs/web/backend/index.mdx(0 hunks)content/docs/web/backend/installation.mdx(0 hunks)content/docs/web/backend/meta.json(0 hunks)content/docs/web/backend/usage.mdx(0 hunks)content/docs/web/frontend/fullstack.mdx(0 hunks)content/docs/web/frontend/index.mdx(0 hunks)content/docs/web/frontend/installation.mdx(0 hunks)content/docs/web/frontend/meta.json(0 hunks)content/docs/web/frontend/quickstart.mdx(0 hunks)content/docs/web/index.mdx(0 hunks)content/docs/web/meta.json(0 hunks)
💤 Files with no reviewable changes (49)
- content/docs/ai-agent/quickstart.mdx
- content/docs/advance-options/meta.json
- content/docs/web/meta.json
- content/docs/meta.json
- content/docs/advance-options/js-injections/programmatic-navigation.mdx
- content/docs/advance-options/js-injections/meta.json
- content/docs/ionic/usage.mdx
- content/docs/advance-options/js-injections/security-risks.mdx
- content/docs/attestor-decentralization/local-development.mdx
- content/docs/web/backend/meta.json
- content/docs/attestor-decentralization/meta.json
- content/docs/js-sdk/index.mdx
- content/docs/oauth/react/hooks.mdx
- content/docs/oauth/react/full-setup.mdx
- content/docs/attestor-decentralization/index.mdx
- content/docs/oauth/react/error-handling.mdx
- content/docs/apis/meta.json
- content/docs/web/backend/usage.mdx
- content/docs/advance-options/js-injections/index.mdx
- content/docs/web/frontend/meta.json
- content/docs/web/backend/index.mdx
- content/docs/ios-swift/installation.mdx
- content/docs/web/frontend/index.mdx
- content/docs/oauth/js/quickstart.mdx
- content/docs/flutter/installation.mdx
- content/docs/advance-options/verification.mdx
- content/docs/oauth/react/index.mdx
- content/docs/advance-options/js-injections/large-payload.mdx
- content/docs/apis/linkedin.mdx
- content/docs/oauth/js/index.mdx
- content/docs/advance-options/overrides.mdx
- content/docs/advance-options/js-injections/verification-options.mdx
- content/docs/advance-options/web-sdk.mdx
- content/docs/oauth/meta.json
- content/docs/oauth/react/api.mdx
- content/docs/web/index.mdx
- content/docs/advance-options/verification-options.mdx
- content/docs/web/frontend/installation.mdx
- content/docs/ai-agent/meta.json
- content/docs/web/frontend/quickstart.mdx
- content/docs/oauth/react/quickstart.mdx
- content/docs/ionic/meta.json
- content/docs/ai-agent/index.mdx
- content/docs/web/backend/installation.mdx
- content/docs/web/frontend/fullstack.mdx
- content/docs/ionic/installation.mdx
- content/docs/attestor-decentralization/attestor-contracts.mdx
- content/docs/apis/x.mdx
- content/docs/advance-options/attestor-auth.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/js-sdk/generating-proof.mdx
[style] ~12-~12: Consider using the more formal “until”.
Context: ...erate a proof. ## User is on a desktop Till January 31 2026, the proofs can generat...
(TILL)
[style] ~26-~26: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...tner) Browser Extension. ## January 31 2026 onwards On January 31, the Reclaim Prot...
(MISSING_COMMA_AFTER_YEAR)
[style] ~144-~144: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...er the proof generation is complete you want to show a custom success message on their ...
(REP_WANT_TO_VB)
content/docs/react-native/installation.mdx
[style] ~82-~82: ‘In the meantime’ might be wordy. Consider a shorter alternative.
Context: ...tigating this issue to find a solution. In the meantime, we recommend temporarily removing expo...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
content/docs/js-sdk/verifying-proofs.mdx
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eration](/js-sdk/generating-proof) is a client side operation to protect the privacy and se...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~9-~9: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...indistinguishable. Verifying proofs is a very simple light weight operation. You can think o...
(EN_WEAK_ADJECTIVE)
content/docs/index.mdx
[style] ~24-~24: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...credit. - Shopping History - if you need to give deals and discounts based on users...
(REP_NEED_TO_VB)
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...tain brands - ... and many more! # Real world example Imagine you want to verify if a...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
content/docs/api-key.mdx
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...roviders when creating the application. You can always go back to your application ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (19)
content/docs/react-native/installation.mdx (1)
76-82: The compatibility notice appears only once, not duplicated.The verification confirms the notice exists solely in the "Using Expo" section (lines 76–82) and is completely absent from the "Without using Expo" section. The enriched summary's claim of duplication is inaccurate. The grep search across the entire file found only two matches (lines 76 and 80), both within the Expo section, with no additional occurrences elsewhere.
Likely an incorrect or invalid review comment.
content/docs/index.mdx (1)
5-6: New content structure and messaging are clear and well-organized.The expanded landing page effectively communicates the protocol's value proposition through:
- Clear intro explaining what the protocol does
- New zkProofs section that demystifies the core artifact
- Real-world example with problem/solution framing that helps users understand the benefit
- Curated resources that direct users to deeper learning paths
The narrative flow guides readers from conceptual understanding (What is Reclaim?) → how it works (zkProofs) → use cases → real-world comparison → further resources.
Also applies to: 10-16, 27-43, 52-62
CLAUDE.md (5)
1-50: Clarify the purpose and scope of CLAUDE.md given the PR title.The PR is titled "removing unnecessary docs and ai slop," but this file represents a significant new addition. Please clarify:
- Is CLAUDE.md intended to consolidate and replace fragmented documentation (i.e., other pages were removed)?
- Or is this file itself considered documentation that should be removed or revised?
- What other documentation pages were modified or removed in this PR?
Without clarity on the broader PR scope, it's difficult to assess whether this consolidation is necessary or redundant with existing docs.
52-110: Verify Web SDK code samples against actual SDK documentation.The JavaScript and Python examples use API patterns (
ReclaimProofRequest.init(),triggerReclaimFlow(),setCallbackUrl()) that should be verified against the current SDK versions to ensure:
- Methods and signatures are accurate
- Return types and callback structures match
- Error handling patterns are idiomatic
I recommend running a quick check against the actual SDK documentation or repository:
- JavaScript SDK repo (if available)
- Package documentation on npm/PyPI
Are you able to verify these code samples match the current SDK APIs?
143-182: Verify mobile SDK setup instructions and current version numbers.The Swift and Kotlin setup instructions reference specific versions (0.3.0) and package repositories (Maven). Confirm:
- Are these versions current and still supported?
- Do these package repositories and URLs still exist and serve the correct binaries?
- Are there any breaking changes or deprecations since these versions?
This is especially important for production documentation.
236-251: Verify zkFetch SDK advanced features code sample.The
responseMatchesandresponseRedactionspatterns in the advanced example should be verified:
- Are the regex pattern syntax and JSON Path expressions correct for the actual SDK?
- Do
Reclaim.verifySignedProof()andReclaim.transformForOnchain()methods exist?- Is the usage pattern shown here accurate?
1-100: CLAUDE.md provides valuable consolidation of protocol documentation.Strengths:
- Well-organized structure with logical flow from basics to advanced topics
- Covers multiple platforms (web, mobile, blockchain) comprehensively
- Concrete code examples across multiple languages
- Best practices and security guidance included
- Good use of headers and formatting for scanability
This appears to effectively consolidate fragmented documentation into a single reference guide.
content/docs/js-sdk/meta.json (1)
3-8: Metadata properly reflects new JS SDK documentation structure.The pages array correctly references the three new modular documentation pages (
preparing-request,generating-proof,verifying-proofs) alongside the persistedinstallationpage. This aligns well with the restructured guides being introduced in the PR.content/docs/android-kotlin/installation.mdx (1)
6-10: Simplified prerequisites and centralized API key setup.The removal of detailed prerequisites and introduction of the "Get an API Key" section aligns well with the broader documentation consolidation pattern. Users are now directed to a centralized guide rather than scattered setup instructions.
content/docs/android-kotlin/usage.mdx (1)
6-43: Well-structured Quickstart with clear credential setup and inline guidance.The reorganization into a Quickstart format improves clarity. The addition of inline guidance for obtaining
APP_ID,APP_SECRET, andPROVIDER_ID(lines 23–24) removes friction for developers. The links to/api-keyand the provider explorer are appropriate and well-placed.content/docs/ios-swift/usage.mdx (1)
7-52: Consistent Quickstart format with clear error handling documentation.The iOS Swift guide follows the same Quickstart pattern as Android, with well-documented credential requirements and exception types. The inline references to the API key guide and provider explorer are consistent across platforms.
content/docs/flutter/usage.mdx (1)
6-56: Flutter Quickstart preserves platform-specific patterns and includes helpful optimization notes.The Dart idiomatic use of
String.fromEnvironment()for credential configuration (lines 15–17) is appropriate. The note clarifying that verification is handled automatically (line 41) is a helpful differentiator from web SDKs and adds value for Flutter developers.content/docs/js-sdk/verifying-proofs.mdx (1)
11-43: Verification quickstart is clear and well-documented.The step-by-step flow from callback setup through data extraction is logical and includes appropriate code examples. Cross-references are consistent with new JS SDK documentation structure.
content/docs/js-sdk/generating-proof.mdx (1)
33-116: Comprehensive quickstart and React example with excellent coverage.The quickstart section provides a clear, step-by-step flow, and the React hook example (lines 72–116) is production-ready with proper error handling and state management. The advanced options section appropriately documents escape hatches for custom UI needs.
content/docs/js-sdk/installation.mdx (2)
8-11: Clear credential onboarding section.The replacement of Prerequisites with a Get API Credentials section is a solid improvement that guides users to obtain necessary credentials upfront before installation.
29-35: Verify cross-references to follow-up documentation.The three-step workflow introduction is clear and helpful. Ensure that the three referenced steps have corresponding documentation pages that are correctly linked in the navigation structure (check
content/docs/js-sdk/meta.jsonor equivalent forpreparing-request,generating-proof, andverifying-proofs).content/docs/js-sdk/preparing-request.mdx (2)
6-42: Solid, progressive quickstart structure.The progression from conceptual explanation through simple code to a real-world Next.js example is well-organized and follows good documentation patterns.
32-32: Verify linked path for verification documentation.Line 32 references
/js-sdk/verify-proof, but confirm this matches the actual page name in the documentation structure. The AI summary mentions a fileverifying-proofs.mdx, which would suggest the path should be/js-sdk/verifying-proofs. Verify path consistency.content/docs/react-native/usage.mdx (1)
3-3: Strong simplification of quickstart and exception handling.The clarifications on credentials access, exception types, and result structures significantly improve onboarding clarity. The progressive structure from simple to advanced is well-organized.
Also applies to: 6-6, 8-8, 14-14, 25-26, 30-30, 32-39
| - **Shopping History** - if you need to give deals and discounts based on users' loyalty to certain brands | ||
| - **... and many more!** | ||
|
|
||
| # Real world example |
There was a problem hiding this comment.
Hyphenate compound adjective "Real-world example".
When "real world" is used as a compound adjective modifying the noun "example," it should be hyphenated.
- # Real world example
+ # Real-world 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.
| # Real world example | |
| # Real-world example |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...tain brands - ... and many more! # Real world example Imagine you want to verify if a...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🤖 Prompt for AI Agents
In content/docs/index.mdx around line 27, the heading uses "Real world example"
without a hyphen; change the compound adjective to "Real-world example" by
inserting a hyphen between "Real" and "world" so the heading reads "Real-world
example".
| # Why do I need to verify, when the proof has already been generated? | ||
| The [proof generation](/js-sdk/generating-proof) is a client side operation to protect the privacy and security of the user. Once the proof is generate, the proof is uploaded to the backend. A malicious user may generate a proof (or not) on their client side - and choose to upload an arbitrary json object to your backend. If you don't verify the proof, the arbitrary JSON object and the actual Prooj JSON object will be indistinguishable. | ||
|
|
||
| Verifying proofs is a very simple light weight operation. You can think of it as verifying the digital signatures to make sure the data is tamper proof. |
There was a problem hiding this comment.
Fix typo and style issues in introductory section.
Line 7 contains a typo: "Prooj" should be "Proof". Additionally, apply these style improvements:
- The [proof generation](/js-sdk/generating-proof) is a client side operation to protect the privacy and security of the user. Once the proof is generate, the proof is uploaded to the backend. A malicious user may generate a proof (or not) on their client side - and choose to upload an arbitrary json object to your backend. If you don't verify the proof, the arbitrary JSON object and the actual Prooj JSON object will be indistinguishable.
+ The [proof generation](/js-sdk/generating-proof) is a client-side operation to protect the privacy and security of the user. Once the proof is generated, it is uploaded to the backend. A malicious user may generate a proof (or not) and choose to upload an arbitrary JSON object to your backend. If you don't verify the proof, distinguishing between the arbitrary and actual proof JSON objects becomes impossible.
-
- Verifying proofs is a very simple light weight operation. You can think of it as verifying the digital signatures to make sure the data is tamper proof.
+
+ Verifying proofs is a straightforward, lightweight operation—similar to verifying digital signatures to ensure data integrity and prevent tampering.📝 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.
| # Why do I need to verify, when the proof has already been generated? | |
| The [proof generation](/js-sdk/generating-proof) is a client side operation to protect the privacy and security of the user. Once the proof is generate, the proof is uploaded to the backend. A malicious user may generate a proof (or not) on their client side - and choose to upload an arbitrary json object to your backend. If you don't verify the proof, the arbitrary JSON object and the actual Prooj JSON object will be indistinguishable. | |
| Verifying proofs is a very simple light weight operation. You can think of it as verifying the digital signatures to make sure the data is tamper proof. | |
| # Why do I need to verify, when the proof has already been generated? | |
| The [proof generation](/js-sdk/generating-proof) is a client-side operation to protect the privacy and security of the user. Once the proof is generated, it is uploaded to the backend. A malicious user may generate a proof (or not) and choose to upload an arbitrary JSON object to your backend. If you don't verify the proof, distinguishing between the arbitrary and actual proof JSON objects becomes impossible. | |
| Verifying proofs is a straightforward, lightweight operation—similar to verifying digital signatures to ensure data integrity and prevent tampering. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eration](/js-sdk/generating-proof) is a client side operation to protect the privacy and se...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~9-~9: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...indistinguishable. Verifying proofs is a very simple light weight operation. You can think o...
(EN_WEAK_ADJECTIVE)
🤖 Prompt for AI Agents
In content/docs/js-sdk/verifying-proofs.mdx around lines 6 to 9, fix the typo
"Prooj" -> "Proof" on line 7 and improve style: correct "Once the proof is
generate" -> "Once the proof is generated", change "client side" to
"client-side" (hyphenated) where used, change "json" to "JSON" for consistency,
and simplify wording to be concise and consistent (e.g., "a malicious user may
generate a proof (or not) on their client-side — and upload an arbitrary JSON
object to your backend" and "Verifying proofs is a lightweight operation" or
similar).
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
content/docs/react-native/usage.mdx (1)
1-50: Move imports to the top of the MDX file (after front matter).MDX files require all imports to be placed immediately after the front matter and before any content. Lines 49-50 contain imports that must be moved to the top of the file. This will cause compilation errors if left in the current position.
Move the imports to the top of the file:
--- title: Usage description: This SDK allows Reclaim Protocol to be triggered from your app, without changing apps. --- +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; + # Quickstart ## Import `inapp-rn-sdk`Then remove the duplicate imports from line 49-50:
- [Expo Example](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/tree/main/samples/example_expo) - for Expo projects -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; - # Advanced options
🧹 Nitpick comments (3)
content/docs/flutter/usage.mdx (1)
217-220: Simplify theming setup explanation for clarity.The sentence at line 219 uses "you need to" twice in close proximity, making it repetitive. Consider restructuring for conciseness:
- The Reclaim SDK supports custom themes to match your app's branding. You need to be on the [enterprise plan](https://dev.reclaimprotocol.org/payment) for custom themeing. After upgrading, you need to contact the Reclaim Protocol team to enable this for you. + The Reclaim SDK supports custom themes to match your app's branding. Custom theming requires an [enterprise plan](https://dev.reclaimprotocol.org/payment). After upgrading, contact the Reclaim Protocol team to enable this feature for your application.content/docs/ios-swift/installation.mdx (1)
6-6: Remove unused import:BadgeGroupLine 6 imports
BadgeGroupfrom@/app/components/badge, but this component is never used in the file. Removing unused imports improves code clarity.-import { BadgeGroup } from '@/app/components/badge'; import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';content/docs/api-key.mdx (1)
25-27: Consider improving sentence variety in the provider setup section.While the static analysis tool flagged potential repetition issues, the current phrasing is acceptable. However, line 25 could be slightly rewarded for better flow: "You will be prompted to add providers during application creation, but you can always return to your application to add more later."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
content/docs/android-kotlin/installation.mdx(2 hunks)content/docs/android-kotlin/usage.mdx(2 hunks)content/docs/api-key.mdx(2 hunks)content/docs/flutter/api-reference.mdx(1 hunks)content/docs/flutter/installation.mdx(1 hunks)content/docs/flutter/usage.mdx(2 hunks)content/docs/ios-swift/installation.mdx(1 hunks)content/docs/ios-swift/usage.mdx(1 hunks)content/docs/js-sdk/backend-verification.mdx(0 hunks)content/docs/js-sdk/client-integration.mdx(0 hunks)content/docs/js-sdk/meta.json(1 hunks)content/docs/js-sdk/preparing-request.mdx(1 hunks)content/docs/js-sdk/quickstart.mdx(0 hunks)content/docs/js-sdk/recommended-setup/index.mdx(0 hunks)content/docs/js-sdk/recommended-setup/meta.json(0 hunks)content/docs/js-sdk/recommended-setup/nextjs.mdx(0 hunks)content/docs/js-sdk/recommended-setup/nodejs.mdx(0 hunks)content/docs/js-sdk/recommended-setup/python.mdx(0 hunks)content/docs/js-sdk/troubleshooting.mdx(0 hunks)content/docs/meta.json(1 hunks)content/docs/react-native/installation.mdx(3 hunks)content/docs/react-native/usage.mdx(1 hunks)
💤 Files with no reviewable changes (9)
- content/docs/js-sdk/client-integration.mdx
- content/docs/js-sdk/quickstart.mdx
- content/docs/js-sdk/backend-verification.mdx
- content/docs/js-sdk/recommended-setup/nodejs.mdx
- content/docs/js-sdk/recommended-setup/nextjs.mdx
- content/docs/js-sdk/recommended-setup/python.mdx
- content/docs/js-sdk/troubleshooting.mdx
- content/docs/js-sdk/recommended-setup/meta.json
- content/docs/js-sdk/recommended-setup/index.mdx
✅ Files skipped from review due to trivial changes (1)
- content/docs/flutter/api-reference.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- content/docs/js-sdk/preparing-request.mdx
- content/docs/flutter/installation.mdx
- content/docs/js-sdk/meta.json
🧰 Additional context used
🪛 LanguageTool
content/docs/android-kotlin/installation.mdx
[grammar] ~34-~34: Use a hyphen to join words.
Context: ...on. Next, add the following to your app level build.gradle file: ```groovy im...
(QB_NEW_EN_HYPHEN)
content/docs/flutter/usage.mdx
[style] ~219-~219: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...r custom themeing. After upgrading, you need to contact the Reclaim Protocol team to en...
(REP_NEED_TO_VB)
content/docs/api-key.mdx
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...roviders when creating the application. You can always go back to your application ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (10)
content/docs/flutter/usage.mdx (1)
1-444: Documentation structure and API coverage look solid.The file presents a well-organized, progressive flow from quickstart through advanced options. The new API surface (ReclaimVerificationResult, CreateClaimOutput, preWarm()) is clearly documented with practical examples. Code samples are accurate and demonstrate proper usage patterns. Coverage of error handling, localization, theming, session management, and platform-specific concerns is comprehensive. This aligns well with the PR's objective to streamline and reorganize the Flutter SDK documentation.
content/docs/meta.json (1)
1-15: All pages in meta.json exist and removed documentation has been properly cleaned up.Verification confirms that all 11 pages referenced in
meta.jsonare present in the codebase—some as.mdxfiles (index.mdx,api-key.mdx,understanding-the-tech.mdx) and others as directories. All six removed documentation sections (oauth,ai-agent,advance-options,attestor-decentralization,apis,ionic) have been successfully deleted. The navigation configuration is complete and consistent with the file tree.content/docs/ios-swift/installation.mdx (1)
18-66: Installation guidance is clear and well-structured.The streamlined installation instructions, condensed from previous multi-accordion format to direct steps for SPM and CocoaPods, align well with the PR's goal of removing unnecessary content. The environment variable fix for physical devices (lines 62-65) is appropriately placed.
content/docs/react-native/usage.mdx (1)
6-46: Quickstart and Advanced Options sections are well-organized.The documentation now follows a clear quickstart flow with comprehensive request parameters and troubleshooting sections. The provider schema block (lines 201-299) and session management examples are thorough and helpful.
content/docs/react-native/installation.mdx (1)
15-190: Installation guidance for React Native is comprehensive and well-structured.The clear separation between Expo and non-Expo setups, detailed Android repository configuration (lines 113-128), and comprehensive iOS setup (lines 134-189) provide developers with the necessary steps. The use of Tabs for build options (lines 42-64) and clear troubleshooting sections enhance usability.
content/docs/ios-swift/usage.mdx (1)
7-112: Quickstart and Advanced Options sections are well-organized with clear examples.The streamlined quickstart (lines 7-54) effectively introduces the basic flow, and the comprehensive request parameters (lines 61-91) and alternative methods (lines 93-111) provide developers with flexibility.
content/docs/api-key.mdx (1)
32-40: Video tutorial addition is a valuable enhancement.The YouTube iframe tutorial effectively supplements the written documentation and provides visual guidance for developers setting up their credentials and providers.
content/docs/android-kotlin/installation.mdx (2)
15-38: Repository configuration and dependency setup are clear and up-to-date.The updated storage URL structure (from
android/0.3.0/repotoandroid/repo) and dependency version (0.21.0) reflect the current SDK version. The Gradle configuration is comprehensive and well-explained.
40-74: AndroidManifest.xml configuration and permissions are comprehensive.The explicit activity declaration, metadata configuration, and clear separation of required vs. optional permissions provide developers with clear guidance on what's necessary and what's conditional.
content/docs/android-kotlin/usage.mdx (1)
6-90: Android Kotlin documentation follows excellent pattern with Quickstart-to-Advanced progression.The clear progression from basic quickstart (lines 6-26) through request creation and verification (lines 29-46) to advanced options (lines 52-90) provides developers with a natural learning path. The complete request parameters example, troubleshooting section for Cronet, and consistent credential guidance align well with the documentation overhaul.
|
|
||
| Some projects may require you to add the repositories to the root `build.gradle` file or your app-level `build.gradle` file's allprojects section. | ||
|
|
||
| Next, add the following to your app level `build.gradle` file: |
There was a problem hiding this comment.
Use hyphenated "app-level" as compound adjective before noun.
When "app level" modifies a noun that follows, it should be hyphenated. This applies consistently throughout the file.
-Next, add the following to your app level `build.gradle` file:
+Next, add the following to your app-level `build.gradle` file:Also update line 41 similarly:
-Add the following to your app level `AndroidManifest.xml` file under the `<application>` tag:
+Add the following to your app-level `AndroidManifest.xml` file under the `<application>` tag:📝 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.
| Next, add the following to your app level `build.gradle` file: | |
| Next, add the following to your app-level `build.gradle` file: |
🧰 Tools
🪛 LanguageTool
[grammar] ~34-~34: Use a hyphen to join words.
Context: ...on. Next, add the following to your app level build.gradle file: ```groovy im...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In content/docs/android-kotlin/installation.mdx around line 34 (and similarly
line 41), replace the non-hyphenated compound adjective "app level" with the
hyphenated form "app-level" when it directly modifies a following noun; update
both occurrences so the phrasing reads "app-level build.gradle file" (or
"app-level <noun>" as appropriate) to use correct compound-adjective
hyphenation.
|
|
||
| ## 1. Create an Application | ||
| Head to [My Applicatons](https://dev.reclaimprotocol.org/my-applications) from the left navigation bar. Here, tap on [Create Application](https://dev.reclaimprotocol.org/application-creation). | ||
| Head to [My Applicatons](https://dev.reclaimprotocol.org/my-applications) from the left navigation bar. Here, tap on [New Application](https://dev.reclaimprotocol.org/application-creation). |
There was a problem hiding this comment.
Fix typo in link text: "Applicatons" → "Applications"
Line 11 contains a misspelling in the link text.
-Head to [My Applicatons](https://dev.reclaimprotocol.org/my-applications) from the left navigation bar. Here, tap on [New Application](https://dev.reclaimprotocol.org/application-creation).
+Head to [My Applications](https://dev.reclaimprotocol.org/my-applications) from the left navigation bar. Here, tap on [New Application](https://dev.reclaimprotocol.org/application-creation).📝 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.
| Head to [My Applicatons](https://dev.reclaimprotocol.org/my-applications) from the left navigation bar. Here, tap on [New Application](https://dev.reclaimprotocol.org/application-creation). | |
| Head to [My Applications](https://dev.reclaimprotocol.org/my-applications) from the left navigation bar. Here, tap on [New Application](https://dev.reclaimprotocol.org/application-creation). |
🤖 Prompt for AI Agents
In content/docs/api-key.mdx around line 11, the link text "My Applicatons" is
misspelled; change it to "My Applications" (leave the URL
https://dev.reclaimprotocol.org/my-applications unchanged) so the visible link
text reads "My Applications" and aligns with correct spelling.
| - [SwiftUI Example](https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk/tree/main/Examples/SwiftUIExample) | ||
| - [SwiftUI with CocoaPods](https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk/tree/main/Examples/SwiftUIWithPodExample) | ||
|
|
||
| # Advance Options |
There was a problem hiding this comment.
Fix section heading typo: "Advance Options" → "Advanced Options"
For consistency with other SDK documentation (React Native, Android Kotlin), the section heading should be "Advanced Options" rather than "Advance Options".
-# Advance Options
+# Advanced Options📝 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.
| # Advance Options | |
| # Advanced Options |
🤖 Prompt for AI Agents
In content/docs/ios-swift/usage.mdx around line 60, the section heading
currently reads "Advance Options" but should be "Advanced Options"; update that
heading text to "Advanced Options" to match other SDK docs and maintain
consistency across documentation.
Description
Testing (ignore for documentation update)
Type of change
Checklist:
Additional Notes:
Note
Major docs overhaul: new JS SDK request/verify guides, overhauled React Native docs, and removal of deprecated Web/OAuth docs with updated navigation.
content/docs/js-sdk/meta.json); addpreparing-request.mdxandverifying-proofs.mdx; remove legacy pages (quickstart, recommended-setup and subpages, troubleshooting).installation.mdx(Expo builds, iOS perf), majorusage.mdxrewrite with quickstart, verification, advanced options, overrides, troubleshooting.content/docs/meta.json.content/docs/meta.json).Written by Cursor Bugbot for commit ba3ed21. This will update automatically on new commits. Configure here.
Summary by CodeRabbit