Docs#449
Open
Bisht13 wants to merge 8 commits into
Open
Conversation
The docs now use a task-oriented structure with clearer setup, end-to-end flows, artifact lifecycle guidance, security notes, and reference pages. The Rust example uses published crates.io packages, SDK examples are tied to verified APIs, and custom visual components align correctly in dark and light themes. Constraint: PR history must use professional commit messages without internal orchestration references. Constraint: Rust dependencies must use published ProveKit crates instead of local path dependencies. Rejected: Preserve intermediate checkpoint commits | they exposed internal coordination noise and made review harder. Rejected: Keep Mermaid diagrams | local rendering was broken and CSS-native diagrams are easier to theme consistently. Confidence: high Scope-risk: moderate Reversibility: clean Directive: Keep docs examples tied to verified crate/API versions and rerun docs checks after visual CSS changes. Tested: git diff --check Tested: pnpm --dir docs check Tested: pnpm --dir docs build Tested: typos README.md docs/README.md docs/src/content/docs docs/astro.config.mjs Not-tested: Hosted production deployment rendering
- Reorganize sidebar (Start here, Build, Concepts, Reference, Operations) - Add: What is ProveKit, Tutorial, Designing circuits, Performance, Comparison, FAQ, Examples catalog, FFI error codes, Starter templates, Changelog - Rewrite landing with code-first hero and trimmed host integrations - Add inline SVG architecture diagram and language tabs on integrations - Verify all CLI flags, FFI codes, WASM bindings, Rust API and Poseidon2 hash arities against source; fix earlier fabrications (PK_OK -> PK_SUCCESS, hash_3 -> chained hash_2, server timeout defaults) - Cross-link rustdoc and glossary anchors - Strip em dashes throughout
Port the brand tokens, type stack, and component rules from the Provekit Design System (README + colors_and_type.css) to the Starlight docs site. - Light is the canonical mode (brand is light-only); head script sets starlight-theme=light on first visit, toggle still works for users who switch - Outfit (display/body) + Geist Mono (chrome) via Google Fonts; --sl-font / --sl-font-mono mapped so Starlight components inherit - Brand palette: canvas #F8FEFF, surface #FFFFFF, ink #2D2D2B, brand #0D74FF, brand-ink #A2D0FC, lines #D1F5FF, mute #949494 - All chrome (sidebar group labels, table headers, TOC heading, pagination labels, asides titles, footer meta, hero CTAs) in Geist Mono ALL CAPS +0.02em tracking - Square corners everywhere (cards, asides, code frames, buttons, dialogs); no box-shadows; borders define structure - Asides re-skinned to brand palette (note=blue, tip=cyan, caution=bloom-orange, danger=bloom-pink) instead of Starlight defaults - Code frames, search dialog, pagination, TOC, sidebar active page, hr / kbd / blockquote / mark, scrollbars all themed - Selectors verified against rendered Starlight DOM; previous attempt targeted .sl-link-card (does not exist) and over-nested sidebar selectors that never matched
- v1.0.0 release wiring: install command, e2e Cargo.toml blocks,
tutorial, starter template all pin "1.0.0"; landing banner,
Changelog, FAQ, Project status acknowledge GitHub Releases as the
authoritative version record
- Installation: surface cargo install provekit-cli alongside the
source-checkout path via Starlight Tabs
- Quickstart: drop redundant prereqs, switch to plain provekit-cli
commands with source-checkout substitution note, fix comma-splice in
success Aside
- What is ProveKit: trim differentiator list to no-trusted-setup +
post-quantum-secure base proof; drop When-to-use, When-not,
You don't / You do need to know sections; replace with one "Before
you build" pointer to the two concept pages
- Post-quantum security mentioned where it belongs: what-is,
security-model (new Cryptographic assumptions section), FAQ (new Q),
comparison matrix (two new rows for base + on-chain wrap)
- Swift platform scope narrowed to iOS only; macOS explicitly
unsupported across landing, installation, swift e2e, starter-template
- Mavros removed from public docs (CLI flag still works, just not
advertised); fixes 9 files
- Theme polish:
- Double-line header bug fixed (scoped border to header.header)
- Inline <code> in table cells stays on one line (no hyphen-wraps)
- Sidebar/TOC inactive items use new --pk-ink-soft mid-tone (#5C5C5A)
instead of pitch-black ink or unreadable mute grey
- Asides reskinned to brand palette (note=blue, tip=cyan,
caution=bloom-orange, danger=bloom-pink)
- Pagination prev/next, code frame, search dialog, scrollbars, kbd,
blockquote, hr all themed
- Light-mode logo variant (logo-light.svg, ink #2D2D2B) replaces
pale brand-ink on white backgrounds
ProveKit docs for integration
Content - Trim concepts, e2e, integrations, and reference pages to honest, ProveKit-specific guidance; remove em-dashes, marketing tone, and legacy "compiler backend" / Mavros references throughout. - Pin v1.0.0 audited release everywhere relevant; note Noir v1.0.0-beta.11 compatibility and the v1 vs main branch policy. - Add post-quantum security wording where it belongs (WHIR base proof is PQ-secure; Groth16 wrap is not). - Drop macOS support (iOS-only for Apple) and clean up SDK ownership notes: Rust is native; JS/Swift/Kotlin SDKs are maintained by Verity (@atheonxyz/verity 0.3.2-beta). - Fix witness-generation flow in the JS/TypeScript end-to-end page; verify and rewrite FFI error codes against tooling/provekit-ffi. - Standardize CLI invocations on plain provekit-cli and confirm Skyscraper as the default --hash. Chrome - Replace Starlight's native <select> ThemeSelect with a custom listbox dropdown matching the brand chrome (Geist Mono caps, square corners, cyan hairline border). - Override Starlight's mobile search button and hamburger button so they no longer render as out-of-place white pills on the dark header; both share a single deduped rule set with hover states for light and dark. - Add per-mode logo (dark wordmark for light theme); fix double header border by scoping rules to header.header.
Audit-driven trims and corrections; no behavior changes: - Drop comparison page (high fabrication risk, marketing-shaped) - Drop changelog page (GitHub Releases is authoritative) - FAQ: consolidate 3 maturity Qs, drop competitor-naming, fix WASM Verifier reusability (clones internally) and Skyscraper-fastest fabrications, drop license/BN254/source-location/changelog Qs - Performance: replace fabricated provekit-bench (criterion → divan) and analyze-pkp claims; correct hash row (sha256/blake3 fastest in proving; skyscraper default for BN254-friendly Groth16 wrap); use witness count, not constraint count, as scaling factor - Security-model: drop generic ZK sections (verification-vs-auth, red-team prompts); ProveKit-specific key handling only - Examples: split runnable circuits vs libraries/workspaces; fix fabricated descriptions (basic-2/3/4 not Poseidon; poseidon-rounds is 1000-round permutation; power is fixed-exponent; oprf full credential workflow) - Error codes: split Code and Constant columns; trim function table to bare names; restructure FFI section in common-errors - CLI overview: two-ways-to-invoke intro; h3 subsections for the inspection/export commands (table was overflowing) - Production checklist: drop generic ops sections (trust boundaries, capture evidence); ProveKit-specific only - Project status: drop Documentation policy and Known launch gaps (doc-team meta + weak aspirational bullets) - Glossary: fix WHIR (PCS, not the proof system), Recursive verifier, BN254 wording - Common errors: group 13 entries under category H2 headings; drop generic Rust toolchain section; fold show-inputs ABI mismatch into Verification failure - Sidebar: reorder Build and integrate (Integrations overview first, then End-to-end overview, then per-platform); move Project status to Reference; rename "Designing circuits for ProveKit" to "Designing circuits" - Em-dash sweep across all MDX and CSS comments
CSP benchmarks
Prover time, peak RSS, peak heap, and verifier time are arithmetic means across the iterations. Peak heap comes from the largest Each metric cell shows the current value followed by the percentage delta against the latest successful Results
|
rose2221
approved these changes
Jun 3, 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.
No description provided.