Skip to content
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

Merged
merged 4 commits into from
Aug 28, 2024
Merged

Conversation

derrekcoleman
Copy link
Contributor

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

@derrekcoleman derrekcoleman added the documentation Improvements or additions to documentation label Aug 28, 2024
@derrekcoleman derrekcoleman self-assigned this Aug 28, 2024
Copy link

changeset-bot bot commented Aug 28, 2024

⚠️ No Changeset found

Latest commit: 1b0eb08

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Aug 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 28, 2024 5:43pm

Comment on lines 29 to 40
```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
Copy link
Contributor

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?

Copy link
Contributor Author

@derrekcoleman derrekcoleman Aug 28, 2024

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!
Copy link
Contributor

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

Copy link
Contributor Author

@derrekcoleman derrekcoleman Aug 28, 2024

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.

docs/docs/learn/guides/bob-gateway/index.md Outdated Show resolved Hide resolved
@gregdhill gregdhill merged commit cdeb7b3 into master Aug 28, 2024
4 checks passed
@gregdhill gregdhill deleted the derrek/docs-gateway-v3-guide branch August 28, 2024 17:59
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.

2 participants