-
Notifications
You must be signed in to change notification settings - Fork 222
Docs update and refactor #510
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
base: master
Are you sure you want to change the base?
Conversation
…precated folder, moving create-leo-app into resources for restored navigation visibility, fixing broken links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First round of review. I would highly suggest sending out separate PRs to close different issues going forward. 3k+ LOC makes it hard to review and catch errors. Additionally, it's easier to track whether the issues have actually been addressed when there are fewer of them.
leo execute main 1u32 2u32 | ||
``` | ||
**NOTE**: Some parts of the transaction below have been abbreviated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it really necessary to add this giant output here? It doesn't seem to teach the reader anything about leo execute
itself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This guide has not been changed from the existing one on the Leo Docs. Rewrite is saved for a future PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure? I don't see the new lines added in https://docs.leo-lang.org/cli/execute
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the refactor!
@@ -8,6 +8,8 @@ sidebar_label: Execute | |||
This command requires having a funded account. | |||
::: | |||
|
|||
You can execute a transition function by using the `leo execute` command. This differs from the `leo run` command in that a transaction and proof of execution are produced, and optionally can be broadcast to the network. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: can be broadcasted
The `leo execute` command executes the Leo program and outputs a transaction object | ||
```bash | ||
leo execute main 1u32 2u32 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This example syntax doesn't work anymore so we should update it,
leo execute main 1u32 2u32 | ||
``` | ||
**NOTE**: Some parts of the transaction below have been abbreviated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure? I don't see the new lines added in https://docs.leo-lang.org/cli/execute
Content Changes
Structure Changes:
create-leo-app
tutorial into the Resources directory. Previously, it was in the SDK directory, which was removed from the site, but the example was still on the "What's New?" pagedeprecated/
directory.TODO's
leo build
,leo run
,leo deploy
, andleo execute
have not been documented due to ambiguity. They are currently listed in the docs exactly as they appear in the CLI outputCloses #494, #496, #498, #500, #502, #507, and #508