AleoHQ
Improve dependency management documentation
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
Motivation
This documentation update accompanies https://github.com/ProvableHQ/leo/pull/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.
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.