From 2bc28b86664b440470e50aed2356f49b106c51e7 Mon Sep 17 00:00:00 2001 From: Pavlenex <36959754+pavlenex@users.noreply.github.com> Date: Mon, 12 Apr 2021 19:49:29 +0200 Subject: [PATCH 1/8] Update guide.md Co-Authored-By: sqcken <70726704+sqcken@users.noreply.github.com> --- guide.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/guide.md b/guide.md index 0f7f5c060..346b8f217 100644 --- a/guide.md +++ b/guide.md @@ -39,32 +39,30 @@ Illustration sources # The bitcoin design guide -**Bitcoin is an incredibly open and public technology that we can all use, be part of, and contribute to. It is also a complex technology that takes time to understand, with a global audience and diverse uses cases. Therefore it's best to combine efforts, share knowledge and support each other in building great Bitcoin products.** +**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.** -This guide was built on that very idea. Like a travel guide, it provides an introduction to a “foreign place”, shows you the highlights and tells you some of the best stories. It provides facts and maps to figure out how to get around, ideas for tours and things to do. Whether you end up taking the official museum tour, clubbing all night or go on shopping sprees is still your choice. Note that these are guides, not mandates. Just like in a foreign city, you can choose to go off the path, and forge a new direction. Others may just follow in the future. +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. ## What's in it? -With Bitcoin being so new and different, a big focus of the guide lies on providing overviews, explanations and best practices for the most common questions and problems. These are the main chapters: +The Bitcoin Design Guide is divided into the following sections: -- [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) is for top-level overviews, whether it's bitcoin technology, visual language, software, or design collaboration in an open-source world -- [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) goes in-depth on the delicate process of introducing new users to bitcoin and how to use specific products and features -- [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) provides extensive details and guidance on the many techniques for storing private keys -- [Payments]({{ '/guide/payments/' | relative_url }}) deals with the complexities of sending and receiving bitcoin across various use cases -- [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles, best practices and other useful information for designing Bitcoin products -- [Case studies]({{ '/guide/case-studies/' | relative_url }}) explores approaches to diverse uses cases with wireframes, designs and prototypes. -- [Glossary]({{ '/guide/glossary/' | relative_url }}) explains common Bitcoin terminology, from Address to ZPUB. +- [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) provides top-level overviews of common visual language, software, and best practices for bitcoin design collaboration +- [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) introduces new users to must know bitcoin terms, products, and features +- [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) details the many techniques that can be used to store private keys +- [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin +- [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals designing Bitcoin products +- [Case studies]({{ '/guide/case-studies/' | relative_url }}) explores wire framing, designing, and prototyping for diverse use cases +- [Glossary]({{ '/guide/glossary/' | relative_url }}) helps you learn the most need-to-know bitcoin terminology from Address to ZPUB ## How to use the guide -If you are new to Bitcoin, continue to the "[Getting started]({{ '/guide/getting-started/introduction/' | relative_url }})" section for an introduction on why Bitcoin is so unique and what makes it so interesting and worthwhile to be involved. As a more experienced reader, you are more than welcome to skip straight to the sections that interest you most. And if you don’t find what you are looking for, try the search function, [ask in the community](http://bitcoindesigners.org) or [file an issue]({{site.github_repository_url}}issues) and help us improve this guide. +Can’t find what you’re looking for? Try [asking the community](http://bitcoindesigners.org), [filing an issue]([file an issue]({{site.github_repository_url}}issues)), or using the search function. ## A community effort -One of the unique aspects of Bitcoin is that it is an open-source project and no single group, company or government owns or controls it. That means all of us can freely participate and contribute as much or as little as we want. All contributions are equally valid, and there are no gatekeepers. This decentralization is an incredibly important property for a global currency as it provides a level playing field for all participants. It also means that there are many different people independently working on different projects, and that we need to help each other to make Bitcoin as useful as possible for as many people as possible. - -This guide is an example of this. It was created and is maintained by a community of designers and design enthusiasts that want to help improve the overall level of design in the Bitcoin ecosystem. It is continuously improved and you are welcome to help, whether it’s providing feedback or adding more content. And if you implement any of the information from this guide in your project, please share how it worked out for you. +We based this guide on the same philosophy of decentralization that bitcoin is built on. This means that no single person, company, or government has control over the guide. Instead, it is maintained by an open and informal community of designers and design enthusiasts. Everyone is welcome to contribute. --- -Now, let's [get started]({{ '/guide/getting-started/introduction/' | relative_url }}). +Let's [get started]({{ '/guide/getting-started/introduction/' | relative_url }}). From 38999d324154325170c35799105592867edf2e01 Mon Sep 17 00:00:00 2001 From: Pavlenex Date: Tue, 13 Apr 2021 18:23:45 +0200 Subject: [PATCH 2/8] Apply suggestions from code review Co-authored-by: Christoph Ono --- guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guide.md b/guide.md index 346b8f217..9efcaa37b 100644 --- a/guide.md +++ b/guide.md @@ -47,7 +47,7 @@ We designed this guide to help anyone navigate those complexities—regardless o The Bitcoin Design Guide is divided into the following sections: -- [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) provides top-level overviews of common visual language, software, and best practices for bitcoin design collaboration +- [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) provides top-level overviews of common visual language, software, and best practices for design collaboration - [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) introduces new users to must know bitcoin terms, products, and features - [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) details the many techniques that can be used to store private keys - [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin @@ -57,7 +57,7 @@ The Bitcoin Design Guide is divided into the following sections: ## How to use the guide -Can’t find what you’re looking for? Try [asking the community](http://bitcoindesigners.org), [filing an issue]([file an issue]({{site.github_repository_url}}issues)), or using the search function. +Can’t find what you’re looking for? Try [asking the community](http://bitcoindesigners.org), [filing an issue]({{site.github_repository_url}}issues), or using the search function. ## A community effort From 4facd1fb9b28bef2419500eb393271136d0485e7 Mon Sep 17 00:00:00 2001 From: Pavlenex <36959754+pavlenex@users.noreply.github.com> Date: Wed, 14 Apr 2021 12:11:50 +0200 Subject: [PATCH 3/8] Update guide.md Co-Authored-By: Christoph Ono <695901+GBKS@users.noreply.github.com> Co-Authored-By: sqcken <70726704+sqcken@users.noreply.github.com> --- guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide.md b/guide.md index 9efcaa37b..2f74eb4c9 100644 --- a/guide.md +++ b/guide.md @@ -48,7 +48,7 @@ We designed this guide to help anyone navigate those complexities—regardless o The Bitcoin Design Guide is divided into the following sections: - [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) provides top-level overviews of common visual language, software, and best practices for design collaboration -- [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) introduces new users to must know bitcoin terms, products, and features +- [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) familiarizes designers with the products, features, and terms needed to create better experiences for first time users - [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) details the many techniques that can be used to store private keys - [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin - [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals designing Bitcoin products From 50ea16f3048861467c9af0a028f0dcefe938a896 Mon Sep 17 00:00:00 2001 From: Pavlenex Date: Tue, 20 Apr 2021 16:51:22 +0200 Subject: [PATCH 4/8] Update guide.md Co-authored-by: Johns Beharry --- guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide.md b/guide.md index 612fde146..a6171e82e 100644 --- a/guide.md +++ b/guide.md @@ -51,7 +51,7 @@ The Bitcoin Design Guide is divided into the following sections: - [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) familiarizes designers with the products, features, and terms needed to create better experiences for first time users - [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) details the many techniques that can be used to store private keys - [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin -- [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals designing Bitcoin products +- [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals of designing Bitcoin products - [Case studies]({{ '/guide/case-studies/' | relative_url }}) explores wire framing, designing, and prototyping for diverse use cases - [Glossary]({{ '/guide/glossary/' | relative_url }}) helps you learn the most need-to-know bitcoin terminology from Address to ZPUB From ae8f0c16197237509dea0bfc4dae5debec0f0d72 Mon Sep 17 00:00:00 2001 From: Pavlenex <36959754+pavlenex@users.noreply.github.com> Date: Tue, 20 Apr 2021 17:05:02 +0200 Subject: [PATCH 5/8] address capitalizaiton of Bitcoin --- guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/guide.md b/guide.md index a6171e82e..f2b1933d3 100644 --- a/guide.md +++ b/guide.md @@ -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 @@ -37,9 +37,9 @@ Illustration sources layout = "full-width" %} -# The bitcoin design guide +# 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. @@ -53,7 +53,7 @@ The Bitcoin Design Guide is divided into the following sections: - [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin - [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals of designing Bitcoin products - [Case studies]({{ '/guide/case-studies/' | relative_url }}) explores wire framing, designing, and prototyping for diverse use cases -- [Glossary]({{ '/guide/glossary/' | relative_url }}) helps you learn the most need-to-know bitcoin terminology from Address to ZPUB +- [Glossary]({{ '/guide/glossary/' | relative_url }}) helps you learn the most need-to-know Bitcoin terminology from Address to ZPUB ## How to use the guide @@ -62,7 +62,7 @@ Can’t find what you’re looking for? Try [asking the community](http://bitcoi ## A community effort -We based this guide on the same philosophy of decentralization that bitcoin is built on. This means that no single person, company, or government has control over the guide. Instead, it is maintained by an open and informal community of designers and design enthusiasts. Everyone is welcome to contribute. +We based this guide on the same philosophy of decentralization that Bitcoin is built on. This means that no single person, company, or government has control over the guide. Instead, it is maintained by an open and informal community of designers and design enthusiasts. Everyone is welcome to contribute. --- From a8fb4ace17c5b22fc2b807e0a69fc822147d2799 Mon Sep 17 00:00:00 2001 From: Pavlenex <36959754+pavlenex@users.noreply.github.com> Date: Tue, 20 Apr 2021 17:15:52 +0200 Subject: [PATCH 6/8] re-base based on #248 --- guide.md | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/guide.md b/guide.md index f2b1933d3..94cf948ee 100644 --- a/guide.md +++ b/guide.md @@ -45,25 +45,41 @@ We designed this guide to help anyone navigate those complexities—regardless o ## What's in it? -The Bitcoin Design Guide is divided into the following sections: +### [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) -- [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) provides top-level overviews of common visual language, software, and best practices for design collaboration -- [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) familiarizes designers with the products, features, and terms needed to create better experiences for first time users -- [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) details the many techniques that can be used to store private keys -- [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin -- [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals of designing Bitcoin products -- [Case studies]({{ '/guide/case-studies/' | relative_url }}) explores wire framing, designing, and prototyping for diverse use cases -- [Glossary]({{ '/guide/glossary/' | relative_url }}) helps you learn the most need-to-know Bitcoin terminology from Address to ZPUB +Provides top-level overviews of common visual language, software, and best practices for design collaboration. +--- + +### [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) + +Familiarizes designers with the products, features, and terms needed to create better experiences for first time users. +--- + +### [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) + +Details the many techniques that can be used to store private keys. +--- +### [Payments]({{ '/guide/payments/' | relative_url }}) -## How to use the guide +Covers the complexities encountered when sending and receiving bitcoin. +--- + +### [Foundations]({{ '/guide/foundations/' | relative_url }}) -Can’t find what you’re looking for? Try [asking the community](http://bitcoindesigners.org), [filing an issue]({{site.github_repository_url}}issues), or using the search function. +Highlights principles and other fundamentals of designing Bitcoin products + +--- -## A community effort +### [Case studies]({{ '/guide/case-studies/' | relative_url }}) -We based this guide on the same philosophy of decentralization that Bitcoin is built on. This means that no single person, company, or government has control over the guide. Instead, it is maintained by an open and informal community of designers and design enthusiasts. Everyone is welcome to contribute. +Explores wire framing, designing, and prototyping for diverse use cases. --- +### [Glossary]({{ '/guide/glossary/' | relative_url }}) + +Helps you learn the most need-to-know Bitcoin terminology from Address to ZPUB + +--- Let's [get started]({{ '/guide/getting-started/introduction/' | relative_url }}). From d2328454deb88b95e1c82d9d856ab9fdf2748fdb Mon Sep 17 00:00:00 2001 From: Pavlenex <36959754+pavlenex@users.noreply.github.com> Date: Tue, 20 Apr 2021 17:19:03 +0200 Subject: [PATCH 7/8] fix formatting --- guide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/guide.md b/guide.md index 94cf948ee..9a170c693 100644 --- a/guide.md +++ b/guide.md @@ -48,21 +48,25 @@ We designed this guide to help anyone navigate those complexities—regardless o ### [Getting started]({{ '/guide/getting-started/introduction/' | relative_url }}) Provides top-level overviews of common visual language, software, and best practices for design collaboration. + --- ### [Onboarding]({{ '/guide/onboarding/introduction/' | relative_url }}) Familiarizes designers with the products, features, and terms needed to create better experiences for first time users. + --- ### [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) Details the many techniques that can be used to store private keys. + --- ### [Payments]({{ '/guide/payments/' | relative_url }}) Covers the complexities encountered when sending and receiving bitcoin. + --- ### [Foundations]({{ '/guide/foundations/' | relative_url }}) From a01e45a9349999f1e7b61ccacbdaa86edf6081f9 Mon Sep 17 00:00:00 2001 From: Pavlenex <36959754+pavlenex@users.noreply.github.com> Date: Thu, 29 Apr 2021 16:39:47 +0200 Subject: [PATCH 8/8] revert case studies section --- guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide.md b/guide.md index 9a170c693..d044cf506 100644 --- a/guide.md +++ b/guide.md @@ -77,7 +77,7 @@ Highlights principles and other fundamentals of designing Bitcoin products ### [Case studies]({{ '/guide/case-studies/' | relative_url }}) -Explores wire framing, designing, and prototyping for diverse use cases. +Explores approaches to diverse uses cases with wireframes, designs and prototypes. ---