Skip to content

Conversation

alex-aleo
Copy link
Collaborator

@alex-aleo alex-aleo commented Aug 25, 2025

Content Changes

  • CLI directory now contains exclusively documentation, with each command getting it's own page, and any subcommands being listed within that page.
  • The previous set of pages in the Testing directory have been rewritten and consolidate into a single Testing guide
  • Various typo corrections and broken link fixes

Structure Changes:

  • The tutorials previously in CLI have been moved to Guides
  • All pages previously in Recipes, Testing, or Guides have been consolidated into a single Guides directory
  • Moved the 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?" page
  • All unused folders and docs have been moved into a dedicated deprecated/ directory.

TODO's

  • Certain flags for leo build, leo run, leo deploy, and leo execute have not been documented due to ambiguity. They are currently listed in the docs exactly as they appear in the CLI output
  • The guide for Querying the Network was left unchanged, currently it just says "Coming Soon!"

Closes #494, #496, #498, #500, #502, #507, and #508

@alex-aleo alex-aleo changed the title Docs Update and Refactor Docs update and refactor Aug 25, 2025
Copy link
Collaborator

@WaltzOfWhispers WaltzOfWhispers left a 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
Copy link
Collaborator

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.

Copy link
Collaborator Author

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.

Copy link
Collaborator

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

Copy link
Collaborator

@WaltzOfWhispers WaltzOfWhispers left a 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.
Copy link
Collaborator

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
Copy link
Collaborator

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
Copy link
Collaborator

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

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.

New leo execute command pattern
3 participants