Skip to content

Conversation

@TheLedgerOfJoudi
Copy link
Contributor

@TheLedgerOfJoudi TheLedgerOfJoudi commented Jun 13, 2025

Summary by CodeRabbit

  • Documentation
    • Added a "Quickstart" section with step-by-step instructions for using zkFetch Cardano integration.
    • Introduced a "Testing" subsection detailing commands for running various tests.
    • Provided guidance on wallet creation, proof requests, and viewing transaction metadata.

@vercel
Copy link

vercel bot commented Jun 13, 2025

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

Name Status Preview Comments Updated (UTC)
docs 🔄 Building (Inspect) Visit Preview 💬 Add feedback Jun 13, 2025 1:44pm

@coderabbitai
Copy link

coderabbitai bot commented Jun 13, 2025

Walkthrough

A new "Quickstart" section was added to the Cardano zkFetch documentation, providing step-by-step setup and usage instructions. A "Testing" subsection was also introduced, outlining commands to run various tests. These changes are limited to documentation and do not alter any code or functionality.

Changes

File(s) Change Summary
content/docs/zkfetch/cardano/cardano_zk_fetch.md Added "Quickstart" and "Testing" sections with setup, usage, and test instructions for users.

Possibly related PRs

Suggested reviewers

  • ChinmayMhatre

Poem

A rabbit hops through docs anew,
Quickstart steps and tests in view.
With Cardano guides so clear and bright,
Setup and proofs are done just right.
🐇✨
Now users leap ahead with glee,
Thanks to this doc simplicity!


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.

@hadi-saleh14 hadi-saleh14 merged commit 9446487 into main Jun 13, 2025
1 of 3 checks passed
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: 0

🧹 Nitpick comments (2)
content/docs/zkfetch/cardano/cardano_zk_fetch.md (2)

44-44: Remove trailing punctuation in headings.
The trailing colon at the end of these step headings violates MD026 (no-trailing-punctuation).
Apply this diff:

- ### Step 1: Clone repository and install packages:
+ ### Step 1: Clone repository and install packages

- ### Step 2: Create a wallet and fund it:
+ ### Step 2: Create a wallet and fund it

- ### Step 3: Request a proof with zkFetch:
+ ### Step 3: Request a proof with zkFetch

- ### Step 4: Send transaction to Preprod:
+ ### Step 4: Send transaction to Preprod

Also applies to: 52-52, 60-60, 68-68

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

44-44: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


49-49: Prefer npm install over npm i for clarity.
The shorthand npm i may be unclear to newcomers; using npm install improves readability.
Apply this diff:

- npm i
+ npm install
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dabfcc9 and 5aa9a9e.

📒 Files selected for processing (1)
  • content/docs/zkfetch/cardano/cardano_zk_fetch.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
content/docs/zkfetch/cardano/cardano_zk_fetch.md

44-44: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


52-52: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


60-60: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)


68-68: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

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.

3 participants