ProveKit docs for integration#435
Open
Bisht13 wants to merge 3 commits into
Open
Conversation
Bisht13
changed the title
Bisht13
changed the title
Bisht13
force-pushed
the
px/docs-e2e-rust-polish
branch
from
7bef68c to
be419eb
Compare
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
|
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
Bisht13
force-pushed
the
px/docs-e2e-rust-polish
branch
from
be419eb to
87171fc
Compare
- 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
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
1 participant
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.
Summary
Validation
git diff --checkpnpm --dir docs checkpnpm --dir docs buildtypos README.md docs/README.md docs/src/content/docs docs/astro.config.mjs