Skip to content

chore(docs): rewrite Build integration pages [skip-line-limit] - #2033

Merged
hmzakhalid merged 1 commit into
docs/build-start-e3-programfrom
docs/build-integrate
Sep 26, 2026
Merged

hmzakhalid merged 1 commit into
docs/build-start-e3-programfrom
docs/build-integrate

Conversation

@hmzakhalid

Copy link
Copy Markdown
Collaborator

Part 6 of 12 of the docs rewrite. This stack replaces #2010, which was too large to review. Each layer builds on the one below it. Merge the layers in order.

Changes

Rewrite the Interfold contract, request, best-practice, SDK, and
client-and-server pages, and the encrypt-and-submit tutorial.

Corrections include: inputs go to the E3 program's publishInput;
getE3PublicKey returns the key commitment; CiphertextOutputPublished
is never emitted (the contract emits
CiphertextOutputReferencePublished); failed-E3 slashed funds go to
honest nodes or the treasury; refunds wait one day after the deadline;
mainnet accepts only the small committee. Every SDK export and
signature is checked against packages/interfold-sdk.

Review focus

The Interfold contract API, the fee and refund rules, and the SDK exports.

Verification

  • The facts on these pages were checked against the code at release 0.18.0. Where noted, they were also checked against mainnet or Sepolia state on 25 September 2026.

  • At this layer: pnpm build in docs/ passes, pnpm check:addresses passes, and Prettier passes on the changed files.

  • Each changed page passes a per-page check: Nextra compile, internal links, and the ASD-STE100 punctuation rules. The archival whitepaper and the constitution are kept word for word.

@hmzakhalid hmzakhalid added the documentation Improvements or additions to documentation label Sep 26, 2026
@vercel

vercel Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
crisp Ready Ready Preview Sep 26, 2026 7:06pm UTC
interfold-dashboard Ready Ready Preview Sep 26, 2026 7:06pm UTC
interfold-docs Ready Ready Preview Sep 26, 2026 7:06pm UTC

Request Review

@vercel
vercel Bot temporarily deployed to Preview – crisp September 26, 2026 13:41 Inactive
@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 34 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: theinterfold/interfold/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 88420756-82f5-4a36-8e8b-544a987838f7

📥 Commits

Reviewing files that changed from the base of the PR and between f59e664 and e2709bf.

📒 Files selected for processing (6)
  • docs/pages/build/best-practices.mdx
  • docs/pages/build/client-and-server.mdx
  • docs/pages/build/interfold-contract.mdx
  • docs/pages/build/requesting-an-e3.mdx
  • docs/pages/build/sdk.mdx
  • docs/pages/build/tutorials/encrypt-and-submit.mdx

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.

Rewrite the Interfold contract, request, best-practice, SDK, and
client-and-server pages, and the encrypt-and-submit tutorial.

Corrections include: inputs go to the E3 program's publishInput;
getE3PublicKey returns the key commitment; CiphertextOutputPublished
is never emitted (the contract emits
CiphertextOutputReferencePublished); failed-E3 slashed funds go to
honest nodes or the treasury; refunds wait one day after the deadline;
mainnet accepts only the small committee. Every SDK export and
signature is checked against packages/interfold-sdk.
@hmzakhalid
hmzakhalid removed this pull request from stack #2040 September 26, 2026 19:13
@hmzakhalid
hmzakhalid added this pull request to stack #2042 September 26, 2026 19:15
@hmzakhalid
hmzakhalid merged commit 83500e5 into main Sep 26, 2026
84 checks passed
An error occurred while trying to automatically change base from docs/build-start-e3-program to main September 26, 2026 19:25
@github-actions
github-actions Bot deleted the docs/build-integrate branch October 4, 2026 03:08

This branch was successfully deployed

3 active deployments
Preview – interfold-docs — e2709bf5 Deployed Sep 26, 2026 by vercel[bot]
Preview – crisp — e2709bf5 Deployed Sep 26, 2026 by vercel[bot]
Preview – interfold-dashboard — e2709bf5 Deployed Sep 26, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants