Skip to content

docs: Update SDK import paths in documentation for web and backend (py)#68

Merged
Kushal7788 merged 1 commit intomainfrom
fix/web-sdk-docs
Jul 14, 2025
Merged

docs: Update SDK import paths in documentation for web and backend (py)#68
Kushal7788 merged 1 commit intomainfrom
fix/web-sdk-docs

Conversation

@kryptocodes
Copy link
Contributor

@kryptocodes kryptocodes commented Jul 14, 2025

Description

This PR updates the documentation to use the correct package names and import statements for the Reclaim Protocol SDKs. The changes ensure consistency with the actual published package names:

  • Updated JavaScript SDK import from 'reclaim-sdk' to '@reclaimprotocol/js-sdk'
  • Updated Python SDK package name from reclaim-sdk to reclaim-python-sdk in the installation verification command

Testing (ignore for documentation update)

n/a

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Checklist:

Summary by CodeRabbit

  • Documentation
    • Updated JavaScript example to use the correct import path for the verification function.
    • Corrected Python SDK installation verification command to reflect the proper package name.

…ctions

Signed-off-by: kryptocodes <srivatsantb@gmail.com>
@vercel
Copy link
Contributor

vercel bot commented Jul 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 14, 2025 1:10pm

@kryptocodes kryptocodes requested a review from Kushal7788 July 14, 2025 13:10
@coderabbitai
Copy link

coderabbitai bot commented Jul 14, 2025

Walkthrough

This update revises documentation in two areas: the JavaScript import path for the verifyProof function in the Web SDK guide, and the Python SDK installation verification command. No changes to code logic or public interfaces are present.

Changes

File(s) Change Summary
content/docs/advance-options/web-sdk.mdx Updated JavaScript import path for verifyProof in documentation.
content/docs/web/backend/installation.mdx Corrected Python package name in installation verification command.

Possibly related PRs

Suggested labels

documentation

Poem

In docs we hop, from path to path,
Updating imports, avoiding wrath.
Python and JS, both get their due,
With names now correct, and guidance true.
A bunny’s delight, clear docs in view!
🐇📚✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 860c66c and 4a90273.

📒 Files selected for processing (2)
  • content/docs/advance-options/web-sdk.mdx (1 hunks)
  • content/docs/web/backend/installation.mdx (1 hunks)
🔇 Additional comments (2)
content/docs/web/backend/installation.mdx (1)

54-57: Package name correction looks good

pip show now targets reclaim-python-sdk, matching the install command on line 49. No further action required.

content/docs/advance-options/web-sdk.mdx (1)

258-258: Import path updated to new scoped package – confirmed

@reclaimprotocol/js-sdk is the published package name and aligns with the change already shown in the installation section. 👍


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@kryptocodes kryptocodes requested a review from Sajjad21990 July 14, 2025 13:12
@Kushal7788 Kushal7788 merged commit 371262d into main Jul 14, 2025
3 checks passed
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