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

Add a Units and Symbols Page #63

Merged
merged 42 commits into from Sep 8, 2021

Conversation

yantiarifin
Copy link
Contributor

@yantiarifin yantiarifin commented Dec 5, 2020

Linked to issue #61. Hello this is Yanti, new contributor here! I will be contributing to the payment section. This is work-in-progress. Take a look below:
https://deploy-preview-63--sad-borg-390916.netlify.app/guide/payments/units-and-symbols/

@johnsBeharry johnsBeharry linked an issue Dec 5, 2020 that may be closed by this pull request
This is a start to the section. More to come.
@GBKS
Copy link
Contributor

GBKS commented Dec 7, 2020

Thanks for starting this. I had gathered some info from a prior Slack discussion (now lost in the archive) in Figma here and here.

I think that Wikipedia is a good reference for standards that we can adopt from other currencies, as well as the country-specific differences to be aware of.

@GBKS GBKS added this to In progress in Content via automation Dec 10, 2020
@GBKS GBKS added Copy Task is about improving text. Design Task is about designing something. labels Dec 10, 2020
@yantiarifin
Copy link
Contributor Author

@johnsBeharry @GBKS - I added more content Units and Symbols and would love to get some feedback. What's the best way to do that?

Copy link
Contributor

@johnsBeharry johnsBeharry left a comment

Choose a reason for hiding this comment

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

@yantiarifin awesome contribution 🎉 !

I've made a few suggestions but I think overall this provides a great base. For wider feedback you should post a link to this issue in slack.

guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
<!--Don't forget to update date -->
11 December 2020

Bitcoin, bits , sats. The format and presentation of bitcoin values are probably amongst the most challenging for new users. The objective of this section is to provide observations of its current usage and recommendations for the best option if multiple formats exist. The goal is not to re-invent the format but to observe the current usage, and eventually to codify it through an organic approach. The surest way to achieve wide-scale adoption is to standardize what is already being used today.
Copy link
Contributor

Choose a reason for hiding this comment

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

We spoke about how these units and symbols come about and how they get adopted I think one sentence on this would be good to reinforce that these "standards" are something that comes from the community and users.


Units may depend on 1. the size of payments which are typical for that user, and 2. the network.

On-chain it may be possible to make a 168,791 bitcoin payment in one transaction but this is not possible on the lightning network. There is also a minimum amount you can transact on-chain.

The minimum amount of bitcoin you can send in a transaction is 546 Satoshis, which is equivalent to 0.00000546 BTC.

While lightning network where smaller near-instant transactions occur - fees can be below a satoshi (milli-satoshi). Wallets which support lightning payments typically default to showing satoshis instead of BTC (although its an option as you illustrated).

Copy link
Contributor

Choose a reason for hiding this comment

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

I added a small note about millisatoshi to the page. How about we wait with more Lightning info for a future PR?


The most common way bitcoin is expressed is BTC (bitcoin) with 8 decimal places. While not as common, denominations of BTC such as mBTC ("millibitcoins"), μBTC ("bits") and sat ("satoshi") are also used. The chart below illutrates how each units relate to the BTC unit.

| Unit | Symbol | Example (English) | Example (Non-English) |
Copy link
Contributor

Choose a reason for hiding this comment

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

I think a conversion columns would be appropriate here to give the reader an understanding on what these units mean.

The English / Non English columns tackle amount display - and if you choose to tackle it I'd say to put it under another heading where you would discuss the locales of thousand and decimal separators.

REF

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this feedback still relevant after the changes I made last week?

yantiarifin and others added 3 commits December 12, 2020 19:19
Co-authored-by: Johns Beharry <johns@peakshift.com>
Co-authored-by: Johns Beharry <johns@peakshift.com>
Co-authored-by: Johns Beharry <johns@peakshift.com>
@johnsBeharry johnsBeharry added this to 🛠 In Progress in Payments Dec 14, 2020
Copy link
Contributor

@johnsBeharry johnsBeharry left a comment

Choose a reason for hiding this comment

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

Date isn't required for the page.

guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
@GBKS
Copy link
Contributor

GBKS commented Jan 6, 2021

@yantiarifin I was wondering what you're thinking about adding details on the display of local currencies. Most people (like me) like to see their bitcoin displayed in Euro or Dollar values.

@yantiarifin
Copy link
Contributor Author

@yantiarifin I was wondering what you're thinking about adding details on the display of local currencies. Most people (like me) like to see their bitcoin displayed in Euro or Dollar values.

@GBKS Good point. Bitcoin values are probably too abstract to have any meaning to most users. I think it would make sense to specify that whenever a bitcoin value is displayed, user can contextually switch to local currency set at the preference level of the app. I can adjust the mockups to include the option to select local currency.

yantiarifin and others added 3 commits January 8, 2021 20:08
Co-authored-by: Johns Beharry <johns@peakshift.com>
Added option to select local currency in mockup image
@GBKS
Copy link
Contributor

GBKS commented Jan 9, 2021

@yantiarifin another thing to consider about local currency display is price volatility. A bitcoin purchase worth €5 from 3 years ago can all of a sudden show up as a €50 purchase if only todays bitcoin->euro rate is used (classic example is the 10,000 bitcoin pizza purchase that's now worth millions). If the application has access to the historical price feed, it can accommodate for that.

I am a big fan of showing both the bitcoin and the converted euro price. Makes it easy to understand the value transferred and also makes you more familiar with the value of bitcoin over time. It does clutter things up a little though.

@yantiarifin
Copy link
Contributor Author

yantiarifin commented Jan 9, 2021

@GBKS I think I should write a separate paragraph on handling local currency. There are a couple ways to do it - contextually give users a way to switch the display between bitcoin and all its denominations and local currency or, another way that I've seen is to always show them visibly together, so you have a BTC display with the ability to change to different denominations and then you also see the local currency equivalent. This would add clutter but I can present some very simple examples on how to keep it clean.

On a separate note, I updated the image ContextualSetting.svg, but git didn't recognize the updated image as a changed file, so working on figuring that out.

@GBKS
Copy link
Contributor

GBKS commented May 12, 2021

To add a few thoughts on this topic from a Slack convo today. Could help to split up formatting into smaller pieces to solve one by one:

  • Currency symbol or name to use (B, BTC, Bitcoin, Sats, Wikipedia)
  • Placement of the symbol (before or after the amount, varies by country)
  • Separators to use (1,000.00, 1.000,00, etc, varies by country)
  • Unit prefix (Wikipedia)
  • Additional visual treatments (like decimals in lighter color, a design choice)

We could provide mockups for some common global currencies to illustrate different combinations. We could also add guidance for different use cases, like lower Satoshi amounts in Lighting vs Bitcoin amounts for apps designed for storing larger amounts.

The PR has gone stale, but is still very relevant.

layout = "float-right-desktop"
%}

Type choices, spacing, color, and other details also affect the ease at which users can understand written amounts. Take a look at the two examples to see which ones are easier to read.
Copy link
Contributor

Choose a reason for hiding this comment

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

@GBKS you have some good settings you told me about when setting numbers. it could be worth mentioning a few of them here by name so people can know what to lookup.

Copy link
Contributor

Choose a reason for hiding this comment

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

I could bake those into the graphic next to this copy, the same way I did in the header graphic.

GBKS and others added 7 commits September 6, 2021 12:35
Co-authored-by: Daniel Nordh <3393669+danielnordh@users.noreply.github.com>
Co-authored-by: Daniel Nordh <3393669+danielnordh@users.noreply.github.com>
Co-authored-by: Daniel Nordh <3393669+danielnordh@users.noreply.github.com>
Instead of a few generic examples, there are now specific tips to consider regarding type treatments for numbers.
The header image is now part of those tips, and I added a new, more decorative image as the new header.

### Digit groups

{% include picture.html
Copy link
Collaborator

Choose a reason for hiding this comment

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

The contrast in the alternate coloring isn't clear, I couldn't see the difference at a first glance.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I went back and forth on that. Too strong of a contrast results makes the numbers hard to read, and too little contrast is barely noticeable. I went for low contrast after experimenting a bit, as it's meant to be a subtle helper and work almost subconsciously. I think designers need to adjust this based on the foreground/background colors they use, as well as font details (thin vs. bold).

Copy link
Collaborator

@Bosch-0 Bosch-0 left a comment

Choose a reason for hiding this comment

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

Looking really good Christoph :)

danielnordh
danielnordh previously approved these changes Sep 8, 2021
Copy link
Contributor

@danielnordh danielnordh left a comment

Choose a reason for hiding this comment

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

This is good to go in my view.
Great work by @GBKS to push this over the line!

Copy link
Contributor

@pavlenex pavlenex left a comment

Choose a reason for hiding this comment

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

Great work all. I have just a few very minor non-contextual, mostly grammar and formatting suggestions, @GBKS care to take a quick look and commit once that you find suitable so we can merge this baby in 🚀 ?

guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Show resolved Hide resolved
guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Outdated Show resolved Hide resolved
guide/payments/units-and-symbols.md Show resolved Hide resolved
Co-authored-by: Pavlenex <pavle@pavle.org>
GBKS and others added 2 commits September 8, 2021 13:23
Co-authored-by: Pavlenex <pavle@pavle.org>
Co-authored-by: Pavlenex <pavle@pavle.org>
pavlenex
pavlenex previously approved these changes Sep 8, 2021
@pavlenex pavlenex merged commit 7529026 into BitcoinDesign:master Sep 8, 2021
Content automation moved this from In progress to Done Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Copy Task is about improving text. Design Task is about designing something.
Projects
Payments
🛠 In Progress
Development

Successfully merging this pull request may close these issues.

Foundations / Units & Symbols
6 participants