[Documentation] Reorganization and Upgrade of SDK docs #968
Conversation
This file contains 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
[Documentation] Account management
…dk into docs/sdk-doc-reorganization
[Documentation] Making Transfers
iamalwaysuncomfortable
requested review from
jaketarnow,
alexpitsikoulis,
esren0x and
onetrickwolf
alexpitsikoulis
requested changes
Feb 24, 2025
|
|
||
| The Provable SDK can be installed via npm and yarn package managers. | ||
|
|
||
| ### NPM |
There was a problem hiding this comment.
npm and yarn instructions are switched
…tead of buildExecutionTransaction
[Documentation] Amend transfer examples to use buildTransferTransaction
…ate and intro docs
…dk into docs/sdk-doc-reorganization
jaketarnow
requested changes
Feb 25, 2025
| </p> | ||
|
|
||
|
|
||
| The [Aleo SDK](https://github.com/ProvableHQ/sdk) is an open source TypeScript/JavaScript SDK for building private full stack web applications. The |
There was a problem hiding this comment.
Update to Provable SDK
| * **Aleo Wallets** | ||
|
|
||
| ## Features | ||
| The Aleo SDK provides the following features. Follow the links below for live demonstrations of these features on |
There was a problem hiding this comment.
Update to Provable SDK
…ntro Signed-off-by: Christian W <christian@provable.com>
Docs/create leo app intro
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.
Motivation
Up to this point the SDK docs have been fragmented between a monolithic readme within the SDK repo and several outdated docs on the both Aleo Developer and Leo Language sites. This by no means provides a good experience for new developers attempting to learn how to build their own wallets and zero knowledge web apps on Aleo.
This PR seeks to provide a more easy-to-follow structure to the Provable SDK documentation that provides simple navigation through Aleo SDK usage guides and examples. It does so by creating a
docsfolder that stores a well organized series of markdown documents that can be worked through step by step.This is part of a broader effort to improve the friendliness of the tooling provided by Provable.
Changelog
Related PRs