Skip to content

Conversation

@AleoAlexander
Copy link
Collaborator

@AleoAlexander AleoAlexander 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.

TODOs:

  • Need to work with @d0cd to figure out what needs to be rendered on the in-page sidebar for the new pages

Future Work

  • 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

@AleoAlexander AleoAlexander 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.

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!

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.

blocking comment for someone from Provable to check how these changes show up

@AleoAlexander AleoAlexander requested a review from d0cd September 10, 2025 19:19
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.

LGTM pending the last comment. thank you!

@AleoAlexander AleoAlexander removed the request for review from zklimaleo September 29, 2025 16:58
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

5 participants