Skip to content

chore(docs): add docs component kit and site styles [skip-line-limit] - #2028

Merged
ctrlc03 merged 1 commit into
mainfrom
docs/site-kit
Sep 26, 2026
Merged

ctrlc03 merged 1 commit into
mainfrom
docs/site-kit

Conversation

@hmzakhalid

Copy link
Copy Markdown
Collaborator

Part 1 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.

The stack

  1. docs/site-kit: add docs component kit and site styles
  2. docs/restructure-sections: group pages into Learn, Build, and Operate sections
  3. docs/reference-pages: add Reference pages
  4. docs/learn: rewrite landing page and Learn section
  5. docs/build-start-e3-program: rewrite Build get-started and E3 program
  6. docs/build-integrate: rewrite Build integration pages
  7. docs/build-circuits-tutorials: rewrite Noir circuits and tutorials
  8. docs/operate-setup: rewrite ciphernode setup pages
  9. docs/operate-maintain: rewrite ciphernode operation pages
  10. docs/crisp: rewrite the CRISP pages
  11. docs/internals: rewrite the protocol internals pages
  12. docs/fold-governance: restructure the FOLD and governance pages

The top of the stack is identical to the head of #2010.

Overlap with #2024 to #2026. Those PRs edit docs at the old paths (docs/pages/ciphernode-operators/*, docs/pages/tutorials/operator-troubleshooting.mdx), and #2026 changes the manifest slashing_manager to the live 0x753109Ee36Dc65cC178875AddA30C6433e5bEEe4. Whichever set merges second must move those edits to the new paths (docs/pages/operate/*) and update the SlashingManager address in reference/contracts.mdx, operate/index.mdx, and operate/running.mdx. pnpm check:addresses reports the address mismatch.

Changes

Add the visual kit that the rewritten pages use, in docs/components/ui:
hero, decrypt text, committee ring, lifecycle stepper, flow and layer
diagrams, stats, terminal, link cards, and badges. All motion stops
when the reader asks for reduced motion.

Also:

  • Use the dashboard palette and serif headings in globals.css.
  • Keep heading anchors scrollable. The old display: none on
    .subheading-anchor stopped every #link from scrolling.
  • Select the tab that a #link targets (pages/_app.tsx).
  • Generate sitemap.xml at build time for the docs MCP server.
  • Add the @/components path alias.
  • Stop .prettierignore from skipping docs/pages/build.

Review focus

The React components, CSS, and hooks. The prose pages do not change in this PR.

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.

  • eslint passes on the components and scripts.

Add the visual kit that the rewritten pages use, in docs/components/ui:
hero, decrypt text, committee ring, lifecycle stepper, flow and layer
diagrams, stats, terminal, link cards, and badges. All motion stops
when the reader asks for reduced motion.

Also:
- Use the dashboard palette and serif headings in globals.css.
- Keep heading anchors scrollable. The old `display: none` on
  .subheading-anchor stopped every #link from scrolling.
- Select the tab that a #link targets (pages/_app.tsx).
- Generate sitemap.xml at build time for the docs MCP server.
- Add the @/components path alias.
- Stop .prettierignore from skipping docs/pages/build.
@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 1:43pm UTC
interfold-dashboard Ready Ready Preview Sep 26, 2026 1:43pm UTC
interfold-docs Ready Ready Preview Sep 26, 2026 1:43pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 38 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: 00de4412-4428-43bb-96f1-3c2df068294a

📥 Commits

Reviewing files that changed from the base of the PR and between 51fa741 and ee7c5e5.

📒 Files selected for processing (22)
  • .prettierignore
  • docs/.gitignore
  • docs/components/ui/Badge.tsx
  • docs/components/ui/Flow.tsx
  • docs/components/ui/Hero.tsx
  • docs/components/ui/Icon.tsx
  • docs/components/ui/Lifecycle.tsx
  • docs/components/ui/LinkCards.tsx
  • docs/components/ui/Motion.tsx
  • docs/components/ui/Stats.tsx
  • docs/components/ui/Terminal.tsx
  • docs/components/ui/ThresholdRing.tsx
  • docs/components/ui/hooks.ts
  • docs/components/ui/index.ts
  • docs/components/ui/ui.module.css
  • docs/package.json
  • docs/pages/_app.tsx
  • docs/public/robots.txt
  • docs/scripts/generate-sitemap.mjs
  • docs/styles/globals.css
  • docs/theme.config.jsx
  • docs/tsconfig.json

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 merged commit c450fe1 into main Sep 26, 2026
32 checks passed
@github-actions
github-actions Bot deleted the docs/site-kit branch October 4, 2026 03:08

This branch was successfully deployed

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