Skip to content

Add language to Units & Symbols page describing new ₿-only convention for displaying bitcoin quantities #1171

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

Open
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

matbalez
Copy link

@matbalez matbalez commented Jun 4, 2025

Per @GBKS suggestion, I went with an approach that adds a section to the Units & Symbols page, rather than create an entirely new page.

However, the existing Units & Symbols page leans heavily on existing conventions, so it did not seem natural to inject this alternative convention in the middle of the content. So I opted to introduce a new section at the end of the page that describes this new, emergent convention as being adopted by a small handful of wallets. I describe some of the rationale for the change, provide examples, and a mockup to illustrate what this would look like.

Because this is not a "consensus view" of the design guide, I did not try to represent it as such. Instead I tried to make this informational, and explain that some wallets are starting to adopt this convention. Having this content here in the Design Guide could be helpful for other wallets who might be considering adopting this approach as well.

This is my first PR on the Design Guide so please let me know if I've missed anything.

Closes #1168

Copy link

netlify bot commented Jun 4, 2025

Deploy Preview for bitcoin-design-site ready!

Name Link
🔨 Latest commit 0978fa5
🔍 Latest deploy log https://app.netlify.com/projects/bitcoin-design-site/deploys/6849bc2fef69e4000864d145
😎 Deploy Preview https://deploy-preview-1171--bitcoin-design-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@GBKS GBKS requested a review from Copilot June 5, 2025 11:09
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new section to the Units & Symbols page to describe an emerging ₿-only convention for representing bitcoin quantities.

  • Added a new image set (images_b) to support the visual mockup.
  • Inserted a detailed section including motivation, best practices, examples, a sample mockup, and early adoption details.

@GBKS GBKS added the Design bitcoin products Referring to the Design BTC product section. label Jun 5, 2025
Copy link
Contributor

@GBKS GBKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for creating this PR. I like the addition overall, but I think we need to clarify the framing. The title and first sentence read a bit promotional. And as I mention in one of the comments, the "inspired by" and "emerging among a small handful of forward-looking wallets" are a bit vague. As a reader, I can't tell if it this is about BIP 177 or some interpretation of it, and emerging sounds like the details are not well-defined yet.

Hope the feedback is helpful.

@GBKS
Copy link
Contributor

GBKS commented Jun 6, 2025

Independent of the content, can you please remove the Gemfile changes from this PR? It is breaking the build system, and updates to those dependencies should be done separately from any content changes, since they require everyone who runs things locally to update their dev environment accordingly.

@matbalez
Copy link
Author

matbalez commented Jun 6, 2025

ok i have attempted to revert those 2 gemfiles. please let me know if that looks good?

@matbalez
Copy link
Author

matbalez commented Jun 6, 2025

@GBKS I have tried to address all of your points of feedback on the PR.

I believe the current state strikes a good balance of presenting the rationale for this new/emerging convention and guiding the ₿-curious on how to adopt it.

Let me know if you have any further feedback?

Copy link
Contributor

@yashrajd yashrajd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for tackling this deceptive and tricky topic, and opening the PR so quickly.

That said, a few things tripped me up, so have dropped comments. Forgive me & ignore comments if I completely missed the boat on something fundamental. It all starts with the naming of the format... I suggest calling it "base unit format" as it is simple yet gets to the heart of the matter.

@matbalez
Copy link
Author

matbalez commented Jun 6, 2025

Thank you for your review and suggestions @yashrajd Your feedback was valuable!

I have adopted a handful of suggestions you made that I think make the content clearer and more helpful, updated with a couple of commits. Thank you.

In cases where I didn't agree with your suggestions, I have provided rationale and resolved the comments. If you feel strongly that I am off the mark, please feel free to re-open and we can solicit opinions from others and/or discuss further.

Copy link
Contributor

@GBKS GBKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates, Mat. This looks pretty good now. I just had one larger comment around mentioning BIP 177.

@matbalez
Copy link
Author

Are you happy with the latest changes @GBKS?

Can this be merged now?

@matbalez
Copy link
Author

matbalez commented Jun 16, 2025 via email

@matbalez
Copy link
Author

matbalez commented Jun 16, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design bitcoin products Referring to the Design BTC product section.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Guidance for adopting "bitcoin" as a base unit (BIP 177) in applications
4 participants