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

[Book] Cairo execution artifacts #48

Merged
merged 19 commits into from
Oct 7, 2024

Conversation

Gerson2102
Copy link
Contributor

This the first version of the artifacts docs for the execution.md file. Issue #27

@Gerson2102 Gerson2102 marked this pull request as ready for review October 1, 2024 18:47
Copy link
Member

@dmirgaleev dmirgaleev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey! Let's try to modify that a little bit, something like that:

  1. Page title and general context: add page title (see other doc files for reference) and some words on what we are trying to achieve, e.g. "executing cairo program to obtain execution trace, memory, and AIR inputs"
  2. Installation: list everything you need to do before you can run the program
    2.0. Need rust
    2.1. Corelib: I suggest to split the flow in two steps 1) get the cairo repo, it can be already in the system if you have Scarb or you need to clone manually 2) make a symbolic link to the corelib folder (moving is also ok but less preferrable)
    2.2. Cairo1-run: it's better to use cargo install rather than clone the entire repo

@Gerson2102
Copy link
Contributor Author

Gerson2102 commented Oct 2, 2024

@dmirgaleev For the first point. I'm not sure if what I understood is the thing that you meant. I was thinking about a title for the readme, not this:
image
But I added it anyways.

I put this "executing cairo program to obtain execution trace, memory, and AIR inputs". As the title of the readme.

@Gerson2102
Copy link
Contributor Author

You shared me this some days ago: https://docs.swmansion.com/scarb/docs/reference/global-directories.html#cache-directory
That is related to the second point that you're talking about. But I dont get the point of doing that. I dont know what should I say about it.

@dmirgaleev dmirgaleev linked an issue Oct 3, 2024 that may be closed by this pull request
@Gerson2102
Copy link
Contributor Author

Waiting for all your feedback here mate @dmirgaleev

docs/pages/usage/execution.md Outdated Show resolved Hide resolved
docs/pages/usage/execution.md Outdated Show resolved Hide resolved
@Gerson2102
Copy link
Contributor Author

I think we're done. Let me know sir!
@dmirgaleev

Copy link
Member

@dmirgaleev dmirgaleev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dmirgaleev dmirgaleev merged commit 46ab25c into dipdup-io:master Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Book] Cairo execution artifacts
2 participants