docs: update docs [skip-line-limit]#1519
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 57 minutes and 30 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (18)
📝 WalkthroughWalkthroughThis pull request adds comprehensive technical documentation for internal Interfold protocols (sortition, DKG, ZK proofs, and commitment consistency), updates SDK and package documentation with corrected BFV parameter preset examples, and migrates domain references from enclave.gg to theinterfold.com across documentation and example code. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
examples/CRISP/client/src/pages/Landing/components/Hero.tsx (1)
51-57:⚠️ Potential issue | 🟠 MajorUse HTML anchor tag instead of Link for external URLs.
The
Linkcomponent is designed for internal client-side routing. For external URLs likehttps://docs.theinterfold.comopened withtarget='_blank', use<a href>withrel='noopener noreferrer'to prevent tabnabbing vulnerabilities and follow React Router best practices.Proposed fix
- <Link - target='_blank' - to='https://docs.theinterfold.com' - className='inline-flex cursor-pointer items-center space-x-1 text-lime-600 duration-300 ease-in-out hover:underline hover:opacity-70' - > + <a + target='_blank' + rel='noopener noreferrer' + href='https://docs.theinterfold.com' + className='inline-flex cursor-pointer items-center space-x-1 text-lime-600 duration-300 ease-in-out hover:underline hover:opacity-70' + > <div>Learn more.</div> - </Link> + </a>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/CRISP/client/src/pages/Landing/components/Hero.tsx` around lines 51 - 57, The external navigation is using the React Router Link component in Hero.tsx (the Link element wrapping "Learn more.") which is for internal routing; replace that Link with a plain anchor element (<a href="https://docs.theinterfold.com">) keeping the same className, target='_blank' and add rel='noopener noreferrer' to prevent tabnabbing and follow best practices for external links.
🧹 Nitpick comments (1)
docs/pages/internals/sortition.mdx (1)
30-31: Optional locale consistency tweak: prefer “afterward” over “afterwards.”This keeps wording aligned with American English style in docs.
Suggested edit
- proposed but publicly verifiable afterwards. + proposed but publicly verifiable afterward.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/pages/internals/sortition.mdx` around lines 30 - 31, The sentence referencing `prevrandao` and `e3Id` uses “afterwards”; update that word to “afterward” to match American English locale consistency in the docs—locate the sentence mentioning `prevrandao` and `e3Id` (the description about RANDAO reveal being unpredictable before the block is proposed but publicly verifiable afterwards) and replace “afterwards” with “afterward” while preserving the rest of the wording and punctuation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/pages/internals/zk-proofs.mdx`:
- Around line 25-26: Update the docs map to use the canonical circuit name
"ShareComputation" instead of the two variant labels "SkShareComputation" and
"ESmShareComputation"; reflect that ProofType::C2aSkShareComputation and
ProofType::C2bESmShareComputation both map to CircuitName::ShareComputation and
note that SK vs ESm is resolved by orchestration/input type (see orchestration
in multithread.rs) so replace the two entries with a single ShareComputation
entry and a short note about SK/ESm distinction being handled upstream.
In `@examples/CRISP/packages/crisp-zk-inputs/README.md`:
- Around line 54-55: The README line incorrectly instructs importing order;
update the sentence referencing init() in the README to say "Call init() once
before calling any APIs from `@crisp-e3/zk-inputs`" (or similar) so it no longer
claims you must import before other imports; keep mention that init() fetches
the WASM in browsers and is a no-op in Node.js and ensure the symbol init() and
package name `@crisp-e3/zk-inputs` remain in the revised sentence.
---
Outside diff comments:
In `@examples/CRISP/client/src/pages/Landing/components/Hero.tsx`:
- Around line 51-57: The external navigation is using the React Router Link
component in Hero.tsx (the Link element wrapping "Learn more.") which is for
internal routing; replace that Link with a plain anchor element (<a
href="https://docs.theinterfold.com">) keeping the same className,
target='_blank' and add rel='noopener noreferrer' to prevent tabnabbing and
follow best practices for external links.
---
Nitpick comments:
In `@docs/pages/internals/sortition.mdx`:
- Around line 30-31: The sentence referencing `prevrandao` and `e3Id` uses
“afterwards”; update that word to “afterward” to match American English locale
consistency in the docs—locate the sentence mentioning `prevrandao` and `e3Id`
(the description about RANDAO reveal being unpredictable before the block is
proposed but publicly verifiable afterwards) and replace “afterwards” with
“afterward” while preserving the rest of the wording and punctuation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a45c2e40-6394-4427-aea1-1ade598ffb54
📒 Files selected for processing (18)
README.mddocs/pages/_meta.jsondocs/pages/ciphernode-operators/index.mdxdocs/pages/internals/_meta.jsondocs/pages/internals/commitment-consistency.mdxdocs/pages/internals/dkg.mdxdocs/pages/internals/sortition.mdxdocs/pages/internals/zk-proofs.mdxdocs/pages/sdk.mdxexamples/CRISP/Readme.mdexamples/CRISP/client/src/pages/Landing/components/Hero.tsxexamples/CRISP/packages/crisp-zk-inputs/README.mdexamples/CRISP/program/README.mdpackages/enclave-config/README.mdpackages/enclave-contracts/README.mdpackages/enclave-mcp/README.mdpackages/enclave-mcp/src/index.tspackages/enclave-sdk/README.md
0xjei
requested changes
Apr 15, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary by CodeRabbit