fix(docs): correct factual errors and polish README overhaul#420
Open
wryonik wants to merge 6 commits intopx/docs-readmefrom
Open
fix(docs): correct factual errors and polish README overhaul#420wryonik wants to merge 6 commits intopx/docs-readmefrom
wryonik wants to merge 6 commits intopx/docs-readmefrom
Conversation
- Fix CI badge URL: atheon/provekit -> worldfnd/provekit - Fix Rust version badge: 1.75+ -> nightly (project requires nightly toolchain) - Fix skyscraper description: M31/CM31 -> BN254 (skyscraper is a BN254 hash engine) - Fix setup tip: remove incorrect stable Rust version hint - Add gnark-skyscraper back to Related Projects (active dep in go.mod)
…wledgements - Add quick links row (Getting Started, Examples, Contributing, Issues) - Add end-to-end Example section using noir-examples/basic (verified locally) - Rewrite Related Projects as Acknowledgements in SP1 style, explaining what each dependency contributes to ProveKit specifically - Fix License badge to link to License.md instead of dead anchor - Strip AI-generated marketing language throughout; rewrite in direct, technical prose consistent with SP1, RISC Zero, and gnark conventions
2 tasks
Replace the terse two-sentence formula in each dependency bullet with fuller descriptions that explain what each library does and precisely how ProveKit uses it — closer in depth to how the project actually integrates each dependency.
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
This PR builds on top of #415 with two commits:
Commit 1 — factual error fixes:
atheon/provekit→worldfnd/provekit1.75+→nightly(project requires nightly toolchain perrust-toolchain.toml)skyscraper/coreoperates exclusively on the BN254 scalar field)gnark-skyscraperback to Related Projects (active dependency pinned inrecursive-verifier/go.mod)Commit 2 — polish:
## Examplesection with the realnoir-examples/basicPoseidon hash circuit — all four commands (nargo compile→prepare→prove→verify) verified locally end-to-end## Acknowledgements, explaining what each dependency actually contributes to ProveKit (SP1-style), grounded in the source codeLicense.mdinstead of a dead#anchorTest plan
nargo compile→prepare→prove→verifypipeline run locally againstnoir-examples/basicwith nargov1.0.0-beta.19— exit code 0