Improve dependency management documentation#556
Merged
JoshuaBatty merged 15 commits intomasterfrom Mar 2, 2026
Merged
Conversation
This was referenced Dec 11, 2025
vicsn
previously approved these changes
Dec 11, 2025
Collaborator
vicsn
left a comment
There was a problem hiding this comment.
I have a few questions but overall LGTM.
Would love a redesign to make it simpler to use for developers.
Collaborator
Author
Agreed. Once we have the lock file actually populated a lot of this complexity around edition pinning goes away. Leo would just auto-record resolved editions on first build, and developers wouldn't need to think about it unless they explicitly want to update. |
The requested changes were implemented in #e51c986
mitchmindtree
previously approved these changes
Feb 23, 2026
mohammadfawaz
previously approved these changes
Feb 24, 2026
4d1028b
- Restructure to explain local vs network dependencies upfront - Add step-by-step dependency resolution explanation - Explain why proof-generating commands bypass cache - Document edition pinning use cases - Add V8 constructor requirement note for deploy
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
326c2a5 to
1d2bc26
Compare
mitchmindtree
approved these changes
Mar 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Structure Changes
Content Changes
execute,deploy,upgrade,synthesize) bypass cacheRendered
Motivation
This documentation update accompanies ProvableHQ/leo#29027 which improves edition handling for dependencies. The existing docs did not clearly explain the distinction between local and network dependencies, or why different commands handle caching differently. This should help clarify these concepts for users.