Dawn/sdk reorg #70
Dawn/sdk reorg #70
Conversation
dawnkelly09
added
the
A1 - Maintenance Major
build/applications/wormhole-sdk.md
Outdated
| @@ -5,148 +5,64 @@ description: Explore Wormhole's TypeScript SDK and learn about how to perform di | |||
|
|
|||
| # Wormhole TypeScript SDK | |||
|
|
|||
| The Wormhole TypeScript SDK is useful for interacting with the chains Wormhole supports and the [protocols](#protocols) built on top of Wormhole. | |||
| ## Get Started | |||
There was a problem hiding this comment.
If this section is about getting started with the SDK, I'd expect to see installation instructions here. Maybe this should be renamed to something else?
I'd also move the first paragraph out to an ## Introduction
There was a problem hiding this comment.
I think the introduction could benefit from following the recipe for intros outlined in the style guide: https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md#introductions
Also in the introduction, make sure you mention what else is covered on this page, i.e., installation, example usage, transfers, etc.
build/applications/wormhole-sdk.md
Outdated
| - `sdk-base` - exposes constants | ||
| ```sh | ||
| npm install @wormhole-foundation/sdk-base | ||
| ``` | ||
|
|
||
| - `sdk-definitions` - exposes contract interfaces, basic types, and VAA payload definitions | ||
| ```sh | ||
| npm install @wormhole-foundation/sdk-definitions | ||
| ``` | ||
|
|
||
| - `sdk-evm` - exposes EVM-specific utilities | ||
| ```sh | ||
| npm install @wormhole-foundation/sdk-evm | ||
| ``` | ||
|
|
||
| - `sdk-evm-tokenbridge` - exposes the EVM Token Bridge protocol client | ||
| ```sh | ||
| npm install @wormhole-foundation/sdk-evm-tokenbridge | ||
| ``` |
There was a problem hiding this comment.
I know this was previously like this, but maybe it'd look a little bit better in tabs? Not sure 🤔
build/applications/wormhole-sdk.md
Outdated
| ## Transfers | ||
|
|
||
| While using the [`ChainContext`](#chain-context) and [`Protocol`](#protocols) clients directly is possible, the SDK provides some helpful abstractions for doing things like transferring tokens. | ||
| While using the `ChainContext` and `Protocol` clients directly is possible, the SDK provides some helpful abstractions for doing things like transferring tokens. |
There was a problem hiding this comment.
I don't think it hurts to keep the links 🤷♀️
Description
Attempt to reorganize and fill out the SDK page a bit. Needed some sort of intro and also added a bit more info found when digging around in the repos.
Checklist
wormhole-mkdocsrepo