Update onchain by hadi-saleh14 · Pull Request #96 · reclaimprotocol/docs

hadi-saleh14 · 2026-01-12T11:43:45Z

Note

Aligns onchain docs and navigation, plus small link/copy fixes across SDK guides.

Standardizes onchain pages to a 4-step Implementation Flow with "Next Steps" (Alephzero, Aptos, Cardano, Cosmos, Diamante, Fuel, Gear, Lukso, Mina, NEAR, Polkadot, Solana, Solidity, Starknet, Stellar, Sui, XION)
Updates onchain/index.mdx cards: reordered and expanded entries (e.g., Aleph Zero, Aptos, Cardano, Diamante, Fuel, Gear, Lukso, Mina, NEAR, Polkadot, Solana, Solidity, Starknet, Stellar, Sui, XION) with icons
Fixes JS SDK links: generating-proof now references /js-sdk/preparing-request; installation now points to verifying-proofs
Minor copy/punctuation tweaks in android/usage.mdx, ios-swift/usage.mdx, and Expo guide link anchor in react-native/install/expo.mdx

^{Written by Cursor Bugbot for commit 2f99736. This will update automatically on new commits. Configure here.}

Summary by CodeRabbit

Documentation

Updated documentation formatting and structure across multiple blockchain integration guides with clearer, numbered implementation flows
Corrected cross-reference links and punctuation throughout guides
Reorganized blockchain integration index with updated SDK references
Enhanced implementation step clarity with detailed guidance on proof handling, submission, and verification workflows

_{✏️ Tip: You can customize this high-level summary in your review settings.}

vercel · 2026-01-12T11:43:50Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
docs	Ready	Preview, Comment	Jan 12, 2026 11:43am

coderabbitai · 2026-01-12T11:43:57Z

📝 Walkthrough

Walkthrough

This PR updates documentation across SDK and onchain integration guides with minor punctuation fixes, corrected internal links, and comprehensive restructuring of onchain integration documentation. The onchain integration guides are reorganized from concise "Flow" sections into detailed "Implementation Flow" sections with explicit SDK references and new "Next Steps" guidance.

Changes

Cohort / File(s)	Summary
Punctuation & Text Updates `content/docs/android/usage.mdx`, `content/docs/ios-swift/usage.mdx`	Added trailing periods to API key guide sentences for consistency.
JS SDK Link Corrections `content/docs/js-sdk/generating-proof.mdx`, `content/docs/js-sdk/installation.mdx`	Updated link target in generating-proof from `/preparing-request` to `/js-sdk/preparing-request` and corrected link text from `[verifying-proof]` to `[verifying-proofs]`.
React Native Installation Link `content/docs/react-native/install/expo.mdx`	Updated Ready section link reference from `react-native/installation#using_reclaim` to `/react-native/installation#basic-usage`.
OnChain Integration Index Restructuring `content/docs/onchain/index.mdx`	Replaced and reordered card entries: Solidity→Aleph Zero, Flutter→Aptos, Solana→Cardano, Sui→Diamante, added new Fuel, Lukso, and Mina integrations. Updated corresponding hrefs and icons.
OnChain Chain-Specific Implementations `content/docs/onchain/alephzero/index.mdx`, `content/docs/onchain/aptos/index.mdx`, `content/docs/onchain/cardano/index.mdx`, `content/docs/onchain/cosmos/index.mdx`, `content/docs/onchain/diamante/index.mdx`, `content/docs/onchain/fuel/index.mdx`, `content/docs/onchain/gear/index.mdx`, `content/docs/onchain/lukso/index.mdx`, `content/docs/onchain/mina/index.mdx`, `content/docs/onchain/near/index.mdx`, `content/docs/onchain/polkadot/index.mdx`, `content/docs/onchain/solana/index.mdx`, `content/docs/onchain/solidity/index.mdx`, `content/docs/onchain/starknet/index.mdx`, `content/docs/onchain/stellar/index.mdx`, `content/docs/onchain/sui/index.mdx`, `content/docs/onchain/xion/index.mdx`	Restructured "Flow" sections to "Implementation Flow" with expanded, numbered steps (Request Proofs, Handle Proof Upload, Submit for Verification, Verify On-Chain), explicit SDK references, and new "Next Steps" sections.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Update docs for inapp SDKs #86: Modifies the same documentation files (android/usage.mdx, ios-swift/usage.mdx) with related punctuation and content updates.
hot on-chain fixes #77: Updates the same onchain documentation files with flow section restructuring and SDK reference changes.
removing unecessary docs and ai slop #82: Related changes to JS SDK documentation paths and link targets.

Suggested labels

documentation, enhancement

Suggested reviewers

TheLedgerOfJoudi
Kushal7788

Poem

🐰 The docs now flow with clearer grace,
From terse to structured, implementation pace,
Each chain now shines with SDK light,
Links are fixed, and prose feels right! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Update onchain' is vague and generic, failing to capture the substantial documentation restructuring across 19 onchain blockchain integration files and multiple supporting documentation files.	Use a more descriptive title such as 'Restructure onchain documentation with implementation flows and SDK references' or 'Refactor onchain integration guides with detailed implementation steps' to clearly convey the scope of changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

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 and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @content/docs/onchain/stellar/index.mdx:
- Around line 6-27: Update the "Next Steps" section in
content/docs/onchain/stellar/index.mdx to explicitly reference the Stellar
quickstart guide by linking to quickstart.mdx (e.g., "See the Stellar quickstart
for Soroban contract setup, CLI deployment, and Freighter wallet
configuration"), so Stellar developers can navigate from the high-level
Implementation Flow directly to chain-specific setup instructions.

🧹 Nitpick comments (9)

content/docs/onchain/gear/index.mdx (2)

14-24: Documentation lacks Gear-specific implementation details.

The implementation steps are generic and don't include any Gear-specific guidance such as:

Smart contract code examples for Gear's Actor model

Gear-specific serialization/deserialization patterns

Links to example Gear contracts or templates

This may be intentional to align with the standardized pattern across on-chain docs, but users looking for Gear integration will need more concrete examples to implement verification.

Consider adding a link to Gear-specific contract examples or a reference implementation, similar to how other blockchain-specific docs might reference their respective contract templates.

26-27: Next Steps could be more actionable.

The "Next Steps" section refers users back to SDK documentation, but for an on-chain integration guide, it would be more helpful to also link to:

Gear-specific contract deployment guides

Example repositories demonstrating the full integration

Reclaim's verifier contract addresses on Gear (if deployed)
content/docs/onchain/diamante/index.mdx (1)
24-26: Minor: Trailing whitespace on line 25.

There appears to be trailing whitespace before the "Next Steps" section. While minor, removing it maintains consistency with the other onchain documentation files.
Suggested fix
 4. **Verify On-Chain**
    - Execute the verification process within your smart contract
    - Handle the verification result according to your application logic
-   
+
 ### Next Steps
content/docs/onchain/mina/index.mdx (1)
6-27: Documentation follows the standardized structure.

The Implementation Flow section is well-organized and consistent with other onchain documentation.

Optional terminology consideration: Mina's ecosystem typically refers to "zkApps" rather than "smart contracts." Consider updating lines 20 and 23 to use "zkApp" for more precise Mina-specific terminology, though "smart contract" is widely understood.
📝 Optional: Use Mina-specific terminology
 3. **Submit for Verification**
    - Transform the proof into its serialized format
-   - Submit the serialized proof to your designated smart contract
+   - Submit the serialized proof to your designated zkApp

 4. **Verify On-Chain**
-   - Execute the verification process within your smart contract
+   - Execute the verification process within your zkApp
    - Handle the verification result according to your application logic
content/docs/onchain/sui/index.mdx (1)

6-27: Documentation structure looks good.

The new Implementation Flow section provides a clear, consistent structure that aligns with other onchain documentation. The four-step process and SDK references (/js-sdk/installation, /react-native/installation, /flutter/installation) are well-organized and properly linked.

Unlike the Aleph Zero docs, this file lacks an Overview section. Consider adding a brief overview for consistency across onchain documentation, though this is optional.
content/docs/onchain/fuel/index.mdx (1)
6-27: Consider adding an Overview section for consistency.

The Aptos and Cardano documentation files include an "Overview" section that provides context before the Implementation Flow. This file (and Polkadot, Solidity) lacks this section, creating inconsistency across the onchain documentation.

Consider adding a brief Overview section similar to:
### Overview
The Reclaim Protocol allows you to verify user data proofs on the Fuel blockchain. This integration enables decentralized verification of user-provided proofs through smart contracts.
content/docs/onchain/polkadot/index.mdx (1)

6-27: Structure is consistent with the PR's standardization effort.

The Implementation Flow and Next Steps sections are well-structured. Same note as the Fuel file: consider adding an "Overview" section for consistency with Aptos and Cardano documentation.

content/docs/onchain/solidity/index.mdx (1)

6-27: LGTM with optional enhancement.

The standardized Implementation Flow structure is clear and actionable. For Solidity specifically, an Overview section could be valuable to mention EVM compatibility and the broader applicability across EVM-compatible chains.
content/docs/onchain/index.mdx (1)
7-9: Unused icon imports.

The icons Server, Code2, and Smartphone are imported but not used in any of the Card components. These appear to be leftover from previous cards that were replaced.
🧹 Remove unused imports
 import { Card, Cards } from 'fumadocs-ui/components/card'
-import Server from 'lucide-react/dist/esm/icons/server'
-import Code2 from 'lucide-react/dist/esm/icons/code-2'
-import Smartphone from 'lucide-react/dist/esm/icons/smartphone'
 import Boxes from 'lucide-react/dist/esm/icons/boxes'

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f614cb and 2f99736.

📒 Files selected for processing (23)

content/docs/android/usage.mdx
content/docs/ios-swift/usage.mdx
content/docs/js-sdk/generating-proof.mdx
content/docs/js-sdk/installation.mdx
content/docs/onchain/alephzero/index.mdx
content/docs/onchain/aptos/index.mdx
content/docs/onchain/cardano/index.mdx
content/docs/onchain/cosmos/index.mdx
content/docs/onchain/diamante/index.mdx
content/docs/onchain/fuel/index.mdx
content/docs/onchain/gear/index.mdx
content/docs/onchain/index.mdx
content/docs/onchain/lukso/index.mdx
content/docs/onchain/mina/index.mdx
content/docs/onchain/near/index.mdx
content/docs/onchain/polkadot/index.mdx
content/docs/onchain/solana/index.mdx
content/docs/onchain/solidity/index.mdx
content/docs/onchain/starknet/index.mdx
content/docs/onchain/stellar/index.mdx
content/docs/onchain/sui/index.mdx
content/docs/onchain/xion/index.mdx
content/docs/react-native/install/expo.mdx

🧰 Additional context used

🧠 Learnings (11)