Skip to content

update cardano docs#90

Merged
hadi-saleh14 merged 1 commit intomainfrom
update-cardano-docs
Dec 11, 2025
Merged

update cardano docs#90
hadi-saleh14 merged 1 commit intomainfrom
update-cardano-docs

Conversation

@hadi-saleh14
Copy link
Contributor

@hadi-saleh14 hadi-saleh14 commented Dec 11, 2025

Note

Refreshes Cardano docs: update SDK/repo links, switch wallet example to Lace, standardize “Verify on-chain,” remove obsolete section, and add README link to zkFetch guide.

  • On-chain Cardano docs
    • content/docs/onchain/cardano/index.mdx:
      • Update SDK list: add JS SDK link; remove older React/Node SDK entries.
      • Standardize wording to Verify on-chain.
      • Remove outdated Next Steps section.
    • content/docs/onchain/cardano/quickstart.mdx:
      • Switch wallet example to Lace.
      • Update example repo links and clone command to GitHub (pluts-sdk-onchain-integration).
  • zkFetch Cardano doc
    • content/docs/zkfetch/cardano.md: add link to repository README for full guide.

Written by Cursor Bugbot for commit 82e74d0. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

Documentation

  • Updated Cardano SDK recommendations in integration guides.
  • Updated wallet example to reflect current tooling.
  • Relocated example codebase to new repository.
  • Improved cross-references to supporting documentation.
  • Clarified proof reference requirements for verification workflows.

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

@vercel
Copy link
Contributor

vercel bot commented Dec 11, 2025

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

Project Deployment Preview Comments Updated (UTC)
docs Error Error Dec 11, 2025 5:33am

@coderabbitai
Copy link

coderabbitai bot commented Dec 11, 2025

Walkthrough

Documentation updates across three Cardano-related guides: SDK references shifted from React/Node.js to JS SDK in the onchain index, wallet example changed from Nami to Lace in the quickstart, repository URLs migrated from GitLab to GitHub, and cross-link sentences added to zkFetch Cardano documentation.

Changes

Cohort / File(s) Summary
Cardano onchain documentation
content/docs/onchain/cardano/index.mdx
Updated SDK references in "Request Proofs" from React SDK to JS SDK; removed Node.js SDK reference; added note about proof reference retention in "Handle Proof Upload"; adjusted header capitalization; removed "Next Steps" sections
Cardano quickstart guide
content/docs/onchain/cardano/quickstart.mdx
Updated wallet example from Nami to Lace; changed repository URL from GitLab to GitHub; updated git clone URL to match new repository location
zkFetch Cardano documentation
content/docs/zkfetch/cardano.md
Added cross-link sentences directing readers to repository README after metadata section and following Testing section

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Verify all updated URLs (GitLab to GitHub migration, repository path) are correct and accessible
  • Confirm wallet example change (Nami to Lace) reflects current recommendations
  • Validate SDK reference updates align with actual SDK capabilities and documentation scope

Possibly related PRs

Suggested reviewers

  • TheLedgerOfJoudi
  • ChinmayMhatre

Poem

🐰 Hop along through docs so fine,
From GitLab to GitHub we align,
Nami to Lace, the paths run true,
SDK wisdom, fresh and new!
Cross-links guide us all the way,
Better docs to save the day!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'update cardano docs' is directly related to the changeset, which updates three Cardano-related documentation files with revised SDK recommendations, wallet examples, repository links, and cross-references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-cardano-docs

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
content/docs/onchain/cardano/index.mdx (1)

19-19: Clarify purpose of stored proof reference.

The added sentence about the proof reference being "needed for subsequent verification steps" is helpful context. However, consider linking to the verification section (line 25 onward) or the zkFetch documentation to provide users with concrete next steps.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc564be and 82e74d0.

📒 Files selected for processing (3)
  • content/docs/onchain/cardano/index.mdx (2 hunks)
  • content/docs/onchain/cardano/quickstart.mdx (3 hunks)
  • content/docs/zkfetch/cardano.md (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📚 Learning: 2025-12-03T01:18:34.283Z
Learnt from: CR
Repo: reclaimprotocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T01:18:34.283Z
Learning: Applies to **/*.{js,ts}|**/*.py : Call ReclaimProofRequest.verifyProof(claimData) on received proofs to validate proof authenticity

Applied to files:

  • content/docs/onchain/cardano/index.mdx
📚 Learning: 2025-12-03T01:18:34.283Z
Learnt from: CR
Repo: reclaimprotocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T01:18:34.283Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Use ReclaimProofRequest.init(APP_ID, APP_SECRET, PROVIDER_ID) before calling triggerReclaimFlow() in frontend code

Applied to files:

  • content/docs/onchain/cardano/index.mdx
📚 Learning: 2025-12-03T01:18:34.283Z
Learnt from: CR
Repo: reclaimprotocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T01:18:34.283Z
Learning: Production deployment requires backend proof verification, secure credential management, webhook implementation, error tracking, and rate limiting

Applied to files:

  • content/docs/onchain/cardano/index.mdx
📚 Learning: 2025-12-03T01:18:34.283Z
Learnt from: CR
Repo: reclaimprotocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T01:18:34.283Z
Learning: Applies to **/*.{js,ts}|**/*.py : Always verify proofs server-side in production - do not rely on client-side verification

Applied to files:

  • content/docs/onchain/cardano/index.mdx
📚 Learning: 2025-12-03T01:18:34.283Z
Learnt from: CR
Repo: reclaimprotocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T01:18:34.283Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Call Reclaim.verifySignedProof() before using proof data to ensure cryptographic validity

Applied to files:

  • content/docs/onchain/cardano/index.mdx
📚 Learning: 2025-12-03T01:18:34.283Z
Learnt from: CR
Repo: reclaimprotocol/docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T01:18:34.283Z
Learning: Applies to **/*.{js,jsx,ts,tsx} : Implement startSession with onSuccess and onError callbacks to handle ReclaimProofRequest completion

Applied to files:

  • content/docs/onchain/cardano/index.mdx
🪛 LanguageTool
content/docs/onchain/cardano/index.mdx

[grammar] ~13-~13: Ensure spelling is correct
Context: ... SDK](/js-sdk/installation) for backend anf web implementations - [React Nativ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ 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 (5)
content/docs/onchain/cardano/quickstart.mdx (2)

11-11: Verify Lace wallet is current recommendation.

Ensure that Lace is the currently recommended wallet for Cardano testnet integration and that the documentation reflects the latest ecosystem standards.


13-13: Verify GitHub repository URLs are valid and accessible.

Both the documentation link (line 13) and git clone command (line 36) reference the new GitHub repository. Confirm that https://github.com/reclaimprotocol/pluts-sdk-onchain-integration is the correct, active repository with maintained documentation.

Also applies to: 36-36

content/docs/zkfetch/cardano.md (1)

76-76: Verify repository README link is accessible and current.

The cross-link references https://github.com/reclaimprotocol/zkfetch-cardano-example?tab=readme-ov-file#zkfetch-cardano-example. Confirm this URL correctly targets the repository's README section.

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

13-15: Verify SDK consolidation is complete and documented.

The change consolidates from "React SDK" and "Node.js SDK" to a single "JS SDK" reference. Ensure that:

  • The JS SDK documentation at /js-sdk/installation covers both backend and web use cases mentioned
  • Existing user guides referencing the separate React/Node.js SDKs have been updated or redirected
  • The rationale for this consolidation is documented elsewhere if this is a breaking change

25-25: Case change is consistent with style.

The shift from "Verify On-chain" to "Verify on-chain" aligns with standard documentation style for compound modifiers used as descriptors. This is a positive change.

1. **Request Proofs**
- Implement proof requests using one of our official SDKs:
- [React SDK](/web/frontend) for web applications
- [JS SDK](/js-sdk/installation) for backend anf web implementations
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typo: "anf" should be "and".

Line 13 contains a spelling error that should be corrected to improve documentation quality.

-     - [JS SDK](/js-sdk/installation) for backend anf web implementations
+     - [JS SDK](/js-sdk/installation) for backend and web implementations
📝 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.

Suggested change
- [JS SDK](/js-sdk/installation) for backend anf web implementations
- [JS SDK](/js-sdk/installation) for backend and web implementations
🧰 Tools
🪛 LanguageTool

[grammar] ~13-~13: Ensure spelling is correct
Context: ... SDK](/js-sdk/installation) for backend anf web implementations - [React Nativ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In content/docs/onchain/cardano/index.mdx around line 13, there's a spelling
mistake "anf" that should be corrected to "and"; update the text to read "[JS
SDK](/js-sdk/installation) for backend and web implementations" so the
documentation reads correctly.

@hadi-saleh14 hadi-saleh14 merged commit 728a4bc into main Dec 11, 2025
3 of 4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jan 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants