-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Update Gateway pages for V3 #325
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docs/docs/build/bob-sdk/gateway.md
Outdated
```sh | ||
# with Yarn | ||
$ yarn add @gobob/bob-sdk | ||
|
||
# with npm | ||
$ npm i @gobob/bob-sdk | ||
|
||
# with pnpm | ||
$ pnpm add @gobob/bob-sdk | ||
|
||
# with Bun | ||
$ bun add @gobob/bob-sdk |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we wanna keep this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The npm2yarn
package in the new version provides a tab-switcher between package managers, so we still have multiple options. I opted for that to strive for visual conciseness, but I'm happy to revert if you prefer.
import { base64 } from "@scure/base"; | ||
import { Transaction } from "@scure/btc-signer"; | ||
|
||
// NOTE: It is up to your implementation to sign the PSBT here! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it's not ready yet but we should really detail how to also integrate sats-wagmi as a default example to do this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. Let's add the sats-wagmi example asap in a separate PR.
Updates the Gateway pages in the Learn and Build sections to reflect Gateway V3's new functionality.
The dev step-by-step guide has been updated for the SDK. I researched whether it's possible to add typesense to these codeblocks; it would be nice if readers can hover over the parameters and see their custom type traits. I wasn't able to find anything in the Docusaurus ecosystem.
The user step-by-step guide update can come later, once our app has the LSTs available.
TODO: DocGen based on TSDoc