docs(website): Add dev-mode instructions #1033
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…//github.com/risc0/risc0 into cardosaum/docs/add-risc0-dev-mode-to-website
SchmErik
reviewed
Oct 25, 2023
nategraf
reviewed
Oct 25, 2023
website/docs/faq.md
Outdated
|
|
||
| A risc0 project in dev mode supports ([fake](https://docs.rs/risc0-zkvm/0.18.0/risc0_zkvm/enum.InnerReceipt.html#variant.Fake)) receipt creation and pass-through (fake) 'verification' workflows, so that dev mode may be switched on and off without impacting project workflows. In particular, receipts generated in dev mode still include public outputs written to the [journal](https://dev.risczero.com/terminology#journal). | ||
|
|
||
| However, because the proving process is bypassed, receipts generated in dev mode will fail a standard receipt verification check. Only when the verifier is also built in dev mode will it perform pass-through 'verification' of the fake receipt. |
There was a problem hiding this comment.
This flag is an environment variable checked at runtime rather than at build-time
website/docs/faq.md
Outdated
Comment on lines
269
to
272
| | Dev mode env var | Feature flag off | Feature flag on | | ||
| | ----------------------------- | ------------------------ | ------------------------ | | ||
| | RISC0_DEV_MODE=true | Developer mode activated | Prover panic | | ||
| | RISCO_DEV_MODE={false, unset} | Default project behavior | Default project behavior | |
There was a problem hiding this comment.
Will the verifier panic when the disable-dev-mode flag is on? Also it's not clear just looking at this table which feature flag you are referring to. Directly referencing diable-dev-mode would be helpful to make this table self-contained.
There was a problem hiding this comment.
It will panic, we test for this property here.
I changed the table to reference disable-dev-mode directly, thanks for pointing out!
flaub
reviewed
Oct 25, 2023
|
A reminder to rename the PR before landing. :) |
SchmErik
reviewed
Oct 25, 2023
SchmErik
reviewed
Oct 25, 2023
Cardosaum
changed the title
Co-authored-by: Erik Kaneda <erik@risczero.com>
SchmErik
approved these changes
Oct 26, 2023
|
For prerelease, you can use |
|
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.
Closes #434