Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## Content publishing checklist
When you are ready for your pull request to be reviewed, make sure to go through this list so the reviewer can focus on giving feedback on the content and not have to nitpick.

- [ ] Bitcoin is capitalized B when referring to the protocol
- [ ] Bitcoin is lowercase b when referring to the currency
- [ ] Spelling is US English
- [ ] Image and pictures have alt text
- [ ] Page has a link to the next page if it is within a chapter
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

This is the repository for the [Bitcoin Design Guide](https://bitcoin.design/guide/), and the [bitcoin.design](https://bitcoin.design) community website.

Discussion and collaboration is taking place in the [bitcoin design Slack](http://bitcoindesigners.org) (#bitcoin-design-guide).
Discussion and collaboration is taking place in the [Bitcoin Design Slack](http://bitcoindesigners.org) (#bitcoin-design-guide).

The [Bitcoin Design Guide](https://bitcoin.design/guide/) is a free open-source community resource that helps designers, developers and others working on non-custodial bitcoin-products to create better experiences faster. We hope that, over time, it will cover all relevant types of products, including consumer wallets, merchant interactions, exchanges and more. Better products and experiences should ultimately make it more appealing for anyone to own and use bitcoin.

An equally important goal is that the process of creating this guide nurtures an open-source Bitcoin design community that can carry this, and other projects forward longer term. The [Bitcoin Design Slack](http://bitcoindesigners.org) and the [bitcoin.design](https://bitcoin.design) website are the first steps in this direction.
An equally important goal is that the process of creating this guide nurtures an open-source bitcoin design community that can carry this, and other projects forward longer term. The [Bitcoin Design Slack](http://bitcoindesigners.org) and the [bitcoin.design](https://bitcoin.design) website are the first steps in this direction.

---

Expand All @@ -18,15 +18,15 @@ You can read more about [how to contribute](https://bitcoin.design/guide/contrib

## Guide Content

The guide is meant to be a simple starting-point for anyone looking to build Bitcoin-based applications, while providing deeper topics and value for more experienced Bitcoin designers. Bitcoin is the platform, and the guide should provide information and resources that should be consistent across applications built on top of it.
The guide is meant to be a simple starting-point for anyone looking to build bitcoin-based applications, while providing deeper topics and value for more experienced bitcoin designers. Bitcoin is the platform, and the guide should provide information and resources that should be consistent across applications built on top of it.

The guide is still being created and should be seen as an evolving resource. Similar to the iterative design process, it starts with core parts then grows in ambition based on community support.

Here is the content that is currently live:

[The Bitcoin Design Guide](https://bitcoin.design/guide/)
* [Getting started](https://bitcoin.design/guide/getting-started/introduction/)
* [Designing Bitcoin products](https://bitcoin.design/guide/designing-products/introduction/)
* [Designing bitcoin products](https://bitcoin.design/guide/designing-products/introduction/)
* [Onboarding](https://bitcoin.design/guide/onboarding/introduction/)
* [Private key management](https://bitcoin.design/guide/private-key-management/introduction/)
* [Payments](https://bitcoin.design/guide/payments/)
Expand Down
4 changes: 2 additions & 2 deletions _includes/home-banner.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
{% include_relative /assets/bitcoin-design-community-banner.svg svgId="banner-bitcoin-logo-svg" pathId="banner-bitcoin-logo-path" %}
</div>
<h1>
Design Bitcoin for everyone
Design bitcoin for everyone
</h1>
<p>Open-source design for Bitcoin products.</p>
<p>Open-source design for bitcoin products.</p>
<div class="home-banner-buttons-wrapper">
<a id="link-button-1" href="{{ site.slack_invite_url }}" rel="me">Join us on Slack</a>
<a id="link-button-2" href="{{ "/guide" | relative_url }}" >Design guide</a>
Expand Down
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ image: https://bitcoin.design/assets/images/contribute/contribute-preview.jpg

**So you’re interested in contributing? Fantastic! We welcome, appreciate and encourage new contributions.**

Depending on your skills and interest, you can help in a number of ways. We design, illustrate, write copy and code, do technical research, discuss and answer questions, run workshops and community calls, and more. Design is a multidisciplinary activity and there are many different ways to be part of this community and help improve how we interact with the Bitcoin protocol.
Depending on your skills and interest, you can help in a number of ways. We design, illustrate, write copy and code, do technical research, discuss and answer questions, run workshops and community calls, and more. Design is a multidisciplinary activity and there are many different ways to be part of this community and help improve how we interact with the bitcoin protocol.

## Learn how we work

Expand Down
10 changes: 5 additions & 5 deletions guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: guide
nav_order: 1
title: Guide
secondary_nav_title: Introduction
description: The Bitcoin Design Guide is a reference for the design of Bitcoin applications.
description: The Bitcoin Design Guide is a reference for the design of bitcoin applications.
permalink: /guide/
main_nav: true
secondary_nav: true
Expand Down Expand Up @@ -39,13 +39,13 @@ Illustration sources

# The Bitcoin design guide

**Bitcoin is a global payment protocol that anyone with Internet access can participate in and contribute to. However, because Bitcoin’s use cases are as vast as its user base, building Bitcoin applications can be complicated.**
**Bitcoin is a global payment protocol that anyone with Internet access can participate in and contribute to. However, because bitcoin’s use cases are as vast as its user base, building bitcoin applications can be complicated.**

We designed this guide to help anyone navigate those complexities—regardless of where they live or work. We can’t imagine every possible use case, but we can help you build for them.

{% include tip/tip.html %}

This guide is a work in progress. We are currently adding information about the [Lightning Network]({{ '/guide/glossary/#lightning-network' | relative_url }}) on all relevant pages.
This guide is a work in progress. We are currently adding information about the [Lightning Network]({{ '/guide/glossary/#lightning-network' | relative_url }}) on all relevant pages.

You can track the progress on this [Github issue]({{ 'https://github.com/BitcoinDesign/Guide/issues/478' }}).

Expand All @@ -59,7 +59,7 @@ Provides top-level overviews of common visual language, technology, software, an

---

### [Designing Bitcoin products]({{ '/guide/designing-products/introduction/' | relative_url }})
### [Designing bitcoin products]({{ '/guide/designing-products/introduction/' | relative_url }})

A close look at the design process, from the concept of open design to use cases and frameworks like the usage life cycle.

Expand Down Expand Up @@ -91,7 +91,7 @@ Explores approaches to diverse uses cases with wireframes, designs and prototype

### [Glossary]({{ '/guide/glossary/' | relative_url }})

Helps you learn the most need-to-know Bitcoin terminology from Address to ZPUB
Helps you learn the most need-to-know bitcoin terminology from Address to ZPUB

---

Expand Down
5 changes: 2 additions & 3 deletions guide/case-studies/cloud-backup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: guide
title: Daily spending
description: A mobile Bitcoin wallet case study using automatic cloud backup as a private key management scheme.
description: A mobile bitcoin wallet case study using automatic cloud backup as a private key management scheme.
nav_order: 1
parent: Case studies
permalink: /guide/case-studies/cloud-backup/
Expand Down Expand Up @@ -34,7 +34,7 @@ https://www.figma.com/community/file/968416729557947210

# Cash account / Daily spending

Imagine a product which tries to solve the problem of quickly and easily sending smaller amounts of money to friends and family, or paying for [small purchases]({{ '/guide/designing-products/personal-finance/#day-to-day-spending' | relative_url }}). Ease and speed of use will be important as usage is likely to be on mobile devices and on the go. Users are not expected to be well versed in Bitcoin technology or advanced private key management, which makes it reasonable to worry more about self-inflicted loss than from theft.
Imagine a product which tries to solve the problem of quickly and easily sending smaller amounts of money to friends and family, or paying for [small purchases]({{ '/guide/designing-products/personal-finance/#day-to-day-spending' | relative_url }}). Ease and speed of use will be important as usage is likely to be on mobile devices and on the go. Users are not expected to be well versed in bitcoin technology or advanced private key management, which makes it reasonable to worry more about self-inflicted loss than from theft.

This product connects to the Lightning network, allowing the user to send and receive bitcoin almost instantly. This means that automatic cloud backup will be a necessity for this product in order to backup the user's Lightning channel state. The user's private key can also be backed up to the cloud. For more advanced users, you could offer the option to opt-out of cloud backup of the private key and instead use a [recovery phrase]({{ '/guide/private-key-management/manual-backup/' | relative_url }}).

Expand Down Expand Up @@ -208,4 +208,3 @@ The recovery flow guides the user through restoring their wallet on a new device
nextUrl = "/guide/case-studies/savings-account/"
nextName = "Savings account"
%}

2 changes: 1 addition & 1 deletion guide/case-studies/introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: guide
title: Case studies
description: A range of case study designs for Bitcoin applications.
description: A range of case study designs for bitcoin applications.
nav_order: 8
has_children: true
permalink: /guide/case-studies/
Expand Down
4 changes: 2 additions & 2 deletions guide/case-studies/savings-account.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: guide
title: Savings account
description: A UX case study for a multi-key Bitcoin wallet designed for both daily spending and storing medium amounts.
description: A UX case study for a multi-key bitcoin wallet designed for both daily spending and storing medium amounts.
nav_order: 2
parent: Case studies
permalink: /guide/case-studies/savings-account/
Expand Down Expand Up @@ -171,7 +171,7 @@ https://www.figma.com/community/file/968416729557947210

# Savings account

In this case study, we look at a product that balances daily spending with what a bank would call a [savings]({{ '/guide/designing-products/personal-finance/#savings' | relative_url }}) account where the user might store wealth long term. Safeguards against loss will be a higher priority than with a frequent spending product, and we might therefore accept more friction both when setting up the wallet and when transacting. If users have no prior Bitcoin knowledge we should expect to spend a significant effort educating them to put them in a position to safely operate the wallet product.
In this case study, we look at a product that balances daily spending with what a bank would call a [savings]({{ '/guide/designing-products/personal-finance/#savings' | relative_url }}) account where the user might store wealth long term. Safeguards against loss will be a higher priority than with a frequent spending product, and we might therefore accept more friction both when setting up the wallet and when transacting. If users have no prior bitcoin knowledge we should expect to spend a significant effort educating them to put them in a position to safely operate the wallet product.

The following [prototype](https://www.figma.com/proto/hwispqET5MzsKUpn3i9iqD/Savings-account-case-study?page-id=1%3A55973&node-id=1%3A55974&viewport=-304%2C225%2C0.19710054993629456&scaling=scale-down&starting-point-node-id=1%3A55974&show-proto-sidebar=1) includes initial onboarding, sending bitcoin, and key replacement, which are explained in detail further below.

Expand Down
2 changes: 1 addition & 1 deletion guide/case-studies/shared-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Multi-key on Lightning is still in development. This page will focus on on-chain

{% include tip/close.html %}

The other person does not need to co-sign every transaction, but we might want a *spending limit*, above which both parties need to approve the transaction. All multi-key setups are represented by Bitcoin scripts on the blockchain, and the spending limit can be introduced as a conditional for both the 1-of-2 or 2-of-3 scheme.
The other person does not need to co-sign every transaction, but we might want a *spending limit*, above which both parties need to approve the transaction. All multi-key setups are represented by bitcoin scripts on the blockchain, and the spending limit can be introduced as a conditional for both the 1-of-2 or 2-of-3 scheme.

Although the 1-of-2 scheme could work here, it offers lower protection against both theft and self-inflicted loss, unless rigorous [manual backups]({{ '/guide/private-key-management/manual-backup/' | relative_url }}) are implemented. For this example we will choose the 2-of-3 scheme, but still have to decide on who will hold the third key, and the location of the other two.

Expand Down
2 changes: 1 addition & 1 deletion guide/case-studies/upgradeable-wallet.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: guide
title: Upgradeable account
description: UX case study for a Bitcoin wallet with multiple private key management schemes.
description: UX case study for a bitcoin wallet with multiple private key management schemes.
nav_order: 3
parent: Case studies
permalink: /guide/case-studies/upgradeable-wallet/
Expand Down
8 changes: 4 additions & 4 deletions guide/contribute/content-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ image: https://bitcoin.design/assets/images/guide/contribute/content-guidelines/
retina = "/assets/images/guide/contribute/content-guidelines/content-guidelines@2x.jpg"
mobile = "/assets/images/guide/contribute/content-guidelines/content-guidelines-mobile.jpg"
mobileRetina = "/assets/images/guide/contribute/content-guidelines/content-guidelines-mobile@2x.jpg"
alt-text = "How to correctly spell and capitalize Bitcoin"
alt-text = "How to correctly spell and capitalize bitcoin"
width = 1600
height = 800
layout = "full-width"
Expand All @@ -27,11 +27,11 @@ The Bitcoin Design Guide is the work of many authors with different backgrounds,

### Know your reader

This guide is crafted for anyone interested in building an effective Bitcoin application. A large part of this group are designers and creatives, but also front-end developers, project managers, and others who actively shape the end-user experience. Consider their perspectives and needs first and avoid going into topics that are not relevant to these readers' goals.
This guide is crafted for anyone interested in building an effective bitcoin application. A large part of this group are designers and creatives, but also front-end developers, project managers, and others who actively shape the end-user experience. Consider their perspectives and needs first and avoid going into topics that are not relevant to these readers' goals.

### Apply Bitcoin design principles
### Apply bitcoin design principles

When creating content for the guide make sure to apply the [Bitcoin design principles](/guide/designing-products/principles/) to what you create. These include self-custody, interoperability, decentralization, security, transparency, inclusion, and privacy.
When creating content for the guide make sure to apply the [bitcoin design principles](/guide/designing-products/principles/) to what you create. These include self-custody, interoperability, decentralization, security, transparency, inclusion, and privacy.

### Speak to the reader

Expand Down
2 changes: 1 addition & 1 deletion guide/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Join our open community and help us improve the Bitcoin Design Guide. Here’s w

### [Slack channel]({{ site.slack_invite_url }})

Head over to the Bitcoin [Bitcoin Design Slack community]({{ site.slack_invite_url }}) and join the #bitcoin-design-guide channel. If you don’t have Slack, you can [download it here](https://slack.com/intl/en-rs/downloads) or on the App Store.
Head over to the [Bitcoin Design Slack community]({{ site.slack_invite_url }}) and join the #bitcoin-design-guide channel. If you don’t have Slack, you can [download it here](https://slack.com/intl/en-rs/downloads) or on the App Store.


---
Expand Down
2 changes: 1 addition & 1 deletion guide/contribute/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ Here's a simple footnote[^1]

---

Next, let's move on to the [Glossary]({{ '/guide/glossary/' | relative_url }}) which explains common Bitcoin terms you may come across.
Next, let's move on to the [Glossary]({{ '/guide/glossary/' | relative_url }}) which explains common bitcoin terms you may come across.

{% include next-previous.html
previousUrl = "/guide/contribute/illustration-guidelines/"
Expand Down
2 changes: 1 addition & 1 deletion guide/contribute/review.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ main_classes: -no-top-padding

Peer-review is fundamental for open-source projects. The review process happens in the open, and anyone can preview and assess proposed changes.

Reviewing is a great entry point for new contributors. By inspecting others' work, you can get a better insight into the project, familiarize yourself with our processes and learn about Bitcoin.
Reviewing is a great entry point for new contributors. By inspecting others' work, you can get a better insight into the project, familiarize yourself with our processes and learn about bitcoin.

{% include youtube.html id="OXPReIz9HMs" %}

Expand Down
Loading