risc0
risc0 copied to clipboard
Add docs on website for I/O in the zkVM
This PR seeks to add a new page on the docs site addressing how to handle I/O in the zkVM.
It covers the basics on how to perform input and output operations, focusing solely on file descriptors and deliberately excluding options such as SliceIo
.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
Name | Status | Preview | Comments | Updated (UTC) |
---|---|---|---|---|
website | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Mar 21, 2024 4:42pm |
This pull request is automatically being deployed by Amplify Hosting (learn more).
Access this pull request here: https://pr-1434.d1uc3c4lom8wx5.amplifyapp.com
@Cardosaum looks like it failed some website tests
Thanks for pointing out, @SchmErik !
I didn't know we actually executed rust examples in the docs.
Will fix it ✅
Pages Preview
:---:
:rocket: Deployed preview to https://risc0.github.io/website-preview/risc0/risc0/pr/1434
on branch gh-pages
at 2024-02-13 19:33:32 +0000
work work work
This is a lot of great content, but it's also quite a long doc, which means a lot of maintenance duty for us and a lot to parse through for users.
I wonder if we can get this closer to 100 lines of markdown rather than 250+. Ways to achieve this may include:
- moving details from dev docs into crate docs
- pointing to examples from github rather than writing examples in the docs
- splitting this into more single-purpose docs (e.g., one on handling inputs and one on handling outputs)
- busting out the red pen and cutting unnecessary/redundant parts
Thanks for the feedback, @pdg744! Agree with your points and will work on implementing it.
As I mentioned earlier, I have some concern that this doc will be a relatively high maintenance burden for us, but we can make revisions to address that if/when it becomes an issue.
@pdg744 I agree it can be a high maintenance one, we can make iteration on this to make more manageable and identify where're the pain points and fix over time.
I appreciate your thoughtfulness and all feedback provided! 🙇♂️