Skip to content

chore(docs): rewrite the protocol internals pages [skip-line-limit] - #2038

Merged
hmzakhalid merged 1 commit into
docs/crispfrom
docs/internals
Sep 26, 2026
Merged

hmzakhalid merged 1 commit into
docs/crispfrom
docs/internals

Conversation

@hmzakhalid

Copy link
Copy Markdown
Collaborator

Part 11 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 sortition, PVDKG and ZK proof, and commitment consistency
pages for auditors and core contributors.

  • Sortition documents the per-bond-owner committee cap (fix(sortition): cap committees by bond owner [skip-line-limit] #1994).
  • The DKG page covers the H-member roster, crash tolerance, the
    public-input layouts of both final proofs, and the presets.
  • Commitment consistency lists all 12 links and the accusation flow.
  • Corrections include: no WaitingForRoster state; the C1 proof travels
    in KeyshareCreated; the secure preset lambda is 50; the accusation
    quorum is H; plaintext aggregation starts at T + 1 roster shares.

Review focus

Sortition, the DKG and proof pipeline, and commitment consistency. This is the most technical layer.

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:42 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: 908f10e9-fedd-40d9-9c90-2881020feeeb

📥 Commits

Reviewing files that changed from the base of the PR and between c5a6c4c and 2af1c78.

📒 Files selected for processing (4)
  • docs/pages/internals/_meta.json
  • docs/pages/internals/commitment-consistency.mdx
  • docs/pages/internals/dkg.mdx
  • docs/pages/internals/sortition.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.

ctrlc03
ctrlc03 previously approved these changes Sep 26, 2026
Rewrite the sortition, PVDKG and ZK proof, and commitment consistency
pages for auditors and core contributors.

- Sortition documents the per-bond-owner committee cap (#1994).
- The DKG page covers the H-member roster, crash tolerance, the
  public-input layouts of both final proofs, and the presets.
- Commitment consistency lists all 12 links and the accusation flow.
- Corrections include: no WaitingForRoster state; the C1 proof travels
  in KeyshareCreated; the secure preset lambda is 50; the accusation
  quorum is H; plaintext aggregation starts at T + 1 roster shares.
@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 9fcc382 into main Sep 26, 2026
61 of 84 checks passed
An error occurred while trying to automatically change base from docs/crisp to main September 26, 2026 21:15

This branch was successfully deployed

3 active deployments
Preview – interfold-docs — 2af1c785 Deployed Sep 26, 2026 by vercel[bot]
Preview – crisp — 2af1c785 Deployed Sep 26, 2026 by vercel[bot]
Preview – interfold-dashboard — 2af1c785 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