Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about build process #1659

Open
4 tasks
Cardosaum opened this issue Apr 11, 2024 · 2 comments
Open
4 tasks

Add docs about build process #1659

Cardosaum opened this issue Apr 11, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Cardosaum
Copy link
Contributor

Overview

Currently we do not provide any explanation on how we perform our build process. Having a proper explanation on what happens when a user runs cargo build would be valuable both from an informational and practical perspective.

By understanding the build process users have context on how host and guest code cooperate, where the <guest>_ELF and <guest>_ID constants come from and would save them time when trying to figure out how to get started with guest & host code development.

Requirements

  • Write a documentation page under "Writing your zkVM application" explaining the build process
  • Explain how we use build.rs scripts to glue host and guest code together
  • Explain how we embed <guest>_ELF and <guest>_ID constants as importable values in their host code
  • Take inspiration on the "putting it all together" section of the I/O documentation, and write a section at the end of the build process doc showing how users can import elf and image id in practice ("This is how you can import ELF and image id, look at example X" kind of thing)
Copy link

linear bot commented Apr 11, 2024

@Cardosaum Cardosaum added the documentation Improvements or additions to documentation label Apr 11, 2024
@pdg744 pdg744 assigned Cardosaum and unassigned it09 Apr 26, 2024
@pdg744
Copy link
Contributor

pdg744 commented May 7, 2024

transferring from dev rel board to platform board

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants