Skip to content

Improve dependency management documentation#556

Merged
JoshuaBatty merged 15 commits intomasterfrom
josh/dependencies
Mar 2, 2026
Merged

Improve dependency management documentation#556
JoshuaBatty merged 15 commits intomasterfrom
josh/dependencies

Conversation

@JoshuaBatty
Copy link
Collaborator

@JoshuaBatty JoshuaBatty commented Dec 11, 2025

Structure Changes

  • Restructured the dependency guide for better flow (Adding → Using → Resolution → Caching → Editions → Deploying)

Content Changes

  • Added clear explanation of local vs network dependencies upfront
  • Added step-by-step dependency resolution process
  • Explained why proof-generating commands (execute, deploy, upgrade, synthesize) bypass cache
  • Documented edition pinning use cases
  • Added note about V8 constructor requirements at deploy time
  • Clarified that local dependencies don't have editions

Rendered

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.

Copy link
Collaborator

@AleoAlexander AleoAlexander left a comment

Choose a reason for hiding this comment

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

A few comments

vicsn
vicsn previously approved these changes Dec 11, 2025
Copy link
Collaborator

@vicsn vicsn left a comment

Choose a reason for hiding this comment

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

I have a few questions but overall LGTM.

Would love a redesign to make it simpler to use for developers.

@JoshuaBatty
Copy link
Collaborator Author

I have a few questions but overall LGTM.

Would love a redesign to make it simpler to use for developers.

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.

@JoshuaBatty JoshuaBatty dismissed AleoAlexander’s stale review February 23, 2026 23:51

The requested changes were implemented in #e51c986

mitchmindtree
mitchmindtree previously approved these changes Feb 23, 2026
mohammadfawaz
mohammadfawaz previously approved these changes Feb 24, 2026
JoshuaBatty and others added 8 commits February 24, 2026 11:08
- 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>
JoshuaBatty and others added 7 commits February 24, 2026 11:08
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>
Copy link
Collaborator

@AleoAlexander AleoAlexander left a comment

Choose a reason for hiding this comment

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

lgtm

@JoshuaBatty JoshuaBatty merged commit 38e4620 into master Mar 2, 2026
2 checks passed
@JoshuaBatty JoshuaBatty deleted the josh/dependencies branch March 2, 2026 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants