Repository navigation
chore(docs): add Reference pages [skip-line-limit] - #2030
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Warning Review limit reachedNext included review available in 41 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Repository: theinterfold/interfold/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (9)
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 |
hmzakhalid
added this pull request to stack #2040
September 26, 2026 13:42
8 of 9 tasks
ctrlc03
approved these changes
Sep 26, 2026
ctrlc03
force-pushed
the
docs/reference-pages
branch
from
September 26, 2026 15:35
bc17005 to
1a6e924
Compare
Add the Reference section: - cli: every interfold and interfoldup command and flag, from the clap definitions, checked against the 0.18.0 binary. - configuration: every config key with its type and default, the file discovery order, and E3_* overrides. - contracts: mainnet and Sepolia addresses from deployments/ manifest.json, the live mainnet verifiers with their history, enums, and key events. - glossary: about 70 protocol terms with anchors. Register reference/contracts.mdx as an address consumer, and allow the live mainnet verifier addresses (and the image-ID prefix that the address pattern matches) in scripts/check-addresses.ts. Point the docs MCP fallback list and llms.txt at the new paths.
ctrlc03
force-pushed
the
docs/reference-pages
branch
from
September 26, 2026 15:57
1a6e924 to
d6af08a
Compare
This branch was successfully deployed
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
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.
Part 3 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
Add the Reference section:
clap definitions, checked against the 0.18.0 binary.
file discovery order, and E3_* overrides.
manifest.json, the live mainnet verifiers with their history,
enums, and key events.
Register reference/contracts.mdx as an address consumer, and allow
the live mainnet verifier addresses (and the image-ID prefix that the
address pattern matches) in scripts/check-addresses.ts. Point the docs
MCP fallback list and llms.txt at the new paths.
Review focus
The CLI flag tables, the config key table, and the address tables. Other layers link to anchors on these pages.
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 buildindocs/passes,pnpm check:addressespasses, 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.