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

@stacks/connect updates #964

Merged
merged 6 commits into from
Feb 24, 2025
Merged

@stacks/connect updates #964

merged 6 commits into from
Feb 24, 2025

Conversation

ryanwaits
Copy link
Collaborator

What does this PR do?

Updates copy and examples for @stacks/connect to reflect changes in version v8.x.x

Copy link

vercel bot commented Feb 24, 2025

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

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 24, 2025 7:20pm

@ryanwaits ryanwaits changed the base branch from main to develop February 24, 2025 17:48
formatting tweaks
removed some language around Stacks.js and updated the intro copy
@max-crawford
Copy link
Contributor

Left a few small tweaks directly. Couple larger notes / things I want to gut check @ryanwaits :

Authentication guide

  1. the authenticate users guide talks about "Stacks.js" but now Stacks Connect is entirely separate right? So mentions of Stacks.js can be safely removed?

  2. The guide references "options" that can be configured to customize a connection (e.g. specifying default wallets or forcing wallet selection). Can we add an example of what that option code looks like? Or link to a reference? Feels odd to drop that detail without more context on how devs can learn more if they want to use that.

  3. The bottom of the page mentions an "API reference" but this should just be a library reference, no?

Sign transactions

  1. A meta comment: does "sign transactions" articulate the value prop clearly or would this guide be more clear/compelling to devs if we led with the topline message of "broadcast transactions" and then we just talk about signing transactions in the context of broadcasting them.

Sign messages

  1. I added some copy around use cases. Can you review that and make sure that feels accurate/highlights the most powerful/common use cases?

  2. Related, I'd like to add a bit more context around structured vs unstructured message signing. What do those terms mean, and when might a dev use one vs the other?

Reference

  1. We can remove installation instructions here, no?

  2. I think every method should have a sentence or 2 descriptor. If I'm a new dev trying to learn how to use connect, I go to the reference section to understand how I can use this package, and there is zero context on what these various methods do / what their use cases are.

  3. I think a right hand side bar would be helpful, so devs can quickly navigate to the reference section they are trying to find.

@ryanwaits ryanwaits merged commit 6a0bcca into develop Feb 24, 2025
3 checks passed
@ryanwaits ryanwaits deleted the feat/connect branch February 24, 2025 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants