Update request in docs #110
Merged
+68
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
kryptocodes
approved these changes
Jan 31, 2026
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughDocumentation updates across JS SDK and troubleshooting pages: clarifying an inline comment in a cancel-callback JSON example, replacing a placeholder with a full Next.js proof-verification example, consolidating TypeScript interface and log text updates, and a small front-matter wording change. Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Client
participant API as Next.js API
participant Verifier as verifyProof Service
participant Validator as Backend Validator
Client->>API: POST /api/verify { proofs }
API->>Verifier: verifyProof(proofs)
Verifier-->>API: verificationResult
API->>Validator: isProofValid(verificationResult)
Validator-->>API: valid / invalid
alt valid
API-->>Client: 200 { success: true, data: ... }
else invalid
API-->>Client: 400 { success: false, reason: "invalid proof" }
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/docs/js-sdk/preparing-request.mdx`:
- Around line 99-103: The JSON example contains an inline comment that makes the
block invalid JSON (the `"type": "string", // Name of the exception from the
table below` line); remove the inline comment from the fenced block and either
(A) move the explanatory note outside the block (e.g., add a line immediately
after the code block: "Note: `type` is the exception name from the table
below.") or (B) change the fence to `jsonc`/`javascript` if you intend to keep
inline comments, ensuring the `"type"` field and other keys remain valid JSON in
the code block.
Comment on lines
99
to
103
| ```json | ||
| { | ||
| "type": "string", | ||
| "type": "string", // Name of the exception from the table below | ||
| "message": "string", | ||
| [key: any]: any |
There was a problem hiding this comment.
Inline comment makes the JSON example invalid.
json blocks should be strict JSON; the comment breaks copy‑paste usability. Consider moving the note outside the block or switching the fence to jsonc/javascript if you want inline comments.
✅ Suggested fix (move note outside JSON)
{
- "type": "string", // Name of the exception from the table below
+ "type": "string",
"message": "string",
[key: any]: any
}Add the note right below the block:
Note: `type` is the exception name from the table below.🤖 Prompt for AI Agents
In `@content/docs/js-sdk/preparing-request.mdx` around lines 99 - 103, The JSON
example contains an inline comment that makes the block invalid JSON (the
`"type": "string", // Name of the exception from the table below` line); remove
the inline comment from the fenced block and either (A) move the explanatory
note outside the block (e.g., add a line immediately after the code block:
"Note: `type` is the exception name from the table below.") or (B) change the
fence to `jsonc`/`javascript` if you intend to keep inline comments, ensuring
the `"type"` field and other keys remain valid JSON in the code block.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Testing (ignore for documentation update)
Type of change
Checklist:
Additional Notes:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.