entropyxyz/programs

Building docs fails on Vercel because Makefile does not set up risczero

ameba23 opened this issue · 2 comments

Building API docs currently fails because the Makefile does not include the commands to set up risczero, which is needed in order to build the project.

[11:58:54.699] error: failed to run custom build command for `json-methods v0.1.0 (/vercel/path0/examples/risczero-zkvm-verification/json/methods)`
[11:58:54.699] 
[11:58:54.699] Caused by:
[11:58:54.699]   process didn't exit successfully: `/vercel/path0/target/release/build/json-methods-db59c3ebb0cd51c2/build-script-build` (exit status: 255)
[11:58:54.700]   --- stderr
[11:58:54.700]   The 'risc0' toolchain could not be found.
[11:58:54.700]   To install the risc0 toolchain, use cargo-risczero.
[11:58:54.700]   For example:
[11:58:54.700]     cargo install cargo-risczero
[11:58:54.700]     cargo risczero install

Solution would be to add the two cargo commands above to the Makefile

I got a bit stuck on this #54 and rather than spend time fixing it i think it would be better to publish the programs crates to crates.io and have the automatically built API docs from docs.rs.

I think its important that we have API documentation available now that this is open source, and currently here we have a broken link: https://docs-api-entropy-core.vercel.app/

The determination we've come to today is that the Vercel Project for these docs is deprecated. We'll just move these docs to their ultimate Crates.io location, instead. In light of that, I'm closing this issue, having already removed the associated Vercel Project from our infrastructure.