Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
815563a
Set up foundation resources vs contribute
pavlenex Jan 11, 2021
21b534c
Update formatting.md
pavlenex Jan 11, 2021
d20f22a
add contribute.md
pavlenex Jan 11, 2021
f1f2937
Update content-guidelines.md
pavlenex Jan 11, 2021
8f3fb8d
Update contribute.md
pavlenex Jan 11, 2021
411819f
add examples do's and don't
pavlenex Jan 12, 2021
e9c56fd
formatting
pavlenex Jan 12, 2021
5b68dd1
replace blockquote with italic styling
pavlenex Jan 12, 2021
14419ee
add example of graphical context
pavlenex Jan 12, 2021
1ee9ded
Add better structure to formatting with examples
pavlenex Jan 12, 2021
242da74
Update formatting.md
pavlenex Jan 12, 2021
b931791
re-structure and add lists
pavlenex Jan 12, 2021
d3a3f4b
image formatting
pavlenex Jan 12, 2021
b1a3643
re-structure
pavlenex Jan 12, 2021
f3d0b48
add html tag
pavlenex Jan 12, 2021
4a75454
Update formatting.md
pavlenex Jan 12, 2021
3fb081d
try plaintext
pavlenex Jan 12, 2021
5914984
replace html with markdown
pavlenex Jan 12, 2021
d63035d
Update content-guidelines.md
pavlenex Jan 12, 2021
b0546b5
better link example
pavlenex Jan 12, 2021
b65120b
add yt video instructions
pavlenex Jan 12, 2021
0003c80
liquid raw format, remove encoded img code
pavlenex Jan 12, 2021
8393231
attempt to fix {% raw %}
pavlenex Jan 12, 2021
32664e8
Added Contribute page preview image
GBKS Jan 13, 2021
8ccf00d
Apply suggestions from code review
pavlenex Jan 13, 2021
ca2f800
Apply suggestions from code review
pavlenex Jan 13, 2021
5ab024f
Merge branch 'master' into guide-2
pavlenex Jan 13, 2021
ae13cf9
Remove Resources.md and img folder
pavlenex Jan 13, 2021
3da8052
add footnote, fix figma, move code block
pavlenex Jan 13, 2021
c17ff56
Update formatting.md
pavlenex Jan 13, 2021
d2c1e78
Add minimal info on slack channel and github to guide contribution page
Jan 15, 2021
22d61d3
Change nav title to 'Contribute to Guide'
Jan 15, 2021
3b63202
Make *the* reader....
Jan 15, 2021
15fc322
Bump subheader formatting to differentiate from Do's/Dont's
Jan 15, 2021
1221058
Put 'Do's ahead of 'Don't's
Jan 15, 2021
436feba
*most* people *scan*...
Jan 15, 2021
926db81
Simplify language
Jan 15, 2021
fb49104
Tweaks to language
Jan 15, 2021
6b0ed53
tweaks, add reference to markdown.
Jan 15, 2021
fa9d330
Revert "tweaks, add reference to markdown."
Jan 15, 2021
b674a76
Break
Jan 15, 2021
89ecb12
Typos
Jan 15, 2021
c378d7e
Figma embed tweaks.
Jan 15, 2021
18bfa10
Footnote tweaks
Jan 15, 2021
06771ea
Merge master with Christoph's updates to embeds
Jan 15, 2021
1f071aa
are you -> you are
Jan 15, 2021
f405401
Revert nav title change (too long)
Jan 15, 2021
e39713a
Revert "Revert nav title change (too long)"
Jan 15, 2021
0094abe
Fix parent names
Jan 15, 2021
c9527f6
Update guide/contribute/contribute.md
danielnordh Jan 15, 2021
c441348
Update guide/contribute/contribute.md
danielnordh Jan 15, 2021
75f4b0e
Update guide/contribute/contribute.md
danielnordh Jan 15, 2021
7fced77
Fix parent:
Jan 15, 2021
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
51 changes: 25 additions & 26 deletions guide/contribute/content-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: guide
title: Content guidelines
description: Writing tips for authors of the Bitcoin Design Guide.
nav_order: 10
parent: Contribute
parent: Contribute to guide
permalink: /guide/contribute/content-guidelines/
image: /assets/images/guide/contribute/content-guidelines-preview.jpg
---
Expand All @@ -12,57 +12,56 @@ image: /assets/images/guide/contribute/content-guidelines-preview.jpg

The Bitcoin Design Guide is the work of many authors with different backgrounds, each with their own unique voice and perspective. To help us ensure a consistent written voice throughout the guide, follow these content guidelines.

#### Know your reader
### Know your reader

This guide is crafted for anyone interested in building an effective Bitcoin application. To understand who are you writing for, familiarize yourself with our [Target audience]({{ '/guide/target-audience' | relative_url }}).
This guide is crafted for anyone interested in building an effective Bitcoin application. To understand who you are writing for, familiarize yourself with our [Target audience]({{ '/guide/target-audience' | relative_url }}).

#### Speak to the reader
### Speak to the reader

Address the reader directly. Whenever possible, try using active instead of passive voice. Make reader a part the conversation by using second-person pronouns like "you, your and yours". Do not write in first-person and avoid giving predictions and personal opinions.

##### Don't

*My wallet balance is 1 bitcoin (BTC). If I have recently mined a block, this could be a fresh whole bitcoin. However, it is most likely going to be an accumulation of UTXOs (change) from previous bitcoin transactions.*
Address the reader directly. Whenever possible, try using active instead of passive voice. Make the reader a part the conversation by using second-person pronouns like "you, your and yours". Do not write in first-person and avoid giving predictions and personal opinions.

##### Do

*Your wallet balance is 1 bitcoin (BTC). If you have recently mined a block, this could be a fresh whole bitcoin. However, it is most likely going to be an accumulation of UTXOs (change) from your previous bitcoin transactions.*

##### Don't

*My wallet balance is 1 bitcoin (BTC). If I have recently mined a block, this could be a fresh whole bitcoin. However, it is most likely going to be an accumulation of UTXOs (change) from previous bitcoin transactions.*

#### Use simple language
### Use simple language

Bitcoin is a global currency. Not everyone using this guide is a native English speaker. Make sure you are writing in plain, easy to follow English. If you're still not sure, try using a readability tool to analyze your text and make recommendations. We like [Hemingway](http://www.hemingwayapp.com).

#### Be concise
### Be concise

Focus on information relevant to the reader. Use direct, clear, concise sentences that are easy to understand. Try to reduce the word count to just the right brevity without being obscure.

##### Don't

*The wallet-application will generate a wallet with a keypair, then encrypt and back the key up to a location that the user is unlikely to lose access to, while hard for a malicious third party to gain access to.*

##### Do

*First the application generates a wallet with a keypair. Then, the key is encrypted and backed up to a location convenient and safe for the user, yet hard to for a malicious third-party to gain access to.*

#### Make content scannable
##### Don't

*The wallet-application will generate a wallet with a keypair, then encrypt and back the key up to a location that the user is unlikely to lose access to, while hard for a malicious third party to gain access to.*

### Make content scannable

On the internet, majority of people scans the content before reading it. By scanning, a reader tries to search for relevant information on the page.
Split text into paragraphs, use links, text styling and images to enhance the scanability. Per paragraph, you should have 3-4 sentences.
On the internet, most people scan the content before reading it. By scanning, a reader tries to search for relevant information on the page.
Split text into paragraphs, use links, text styling and images to make this easier. Each paragraph should ideally have no more than 3-4 sentences.

#### Linking
### Linking

[Linking]({{ '/guide/contribute/formatting/#links' | relative_url }}) provides necessary context and helps avoid information repetition. Link to the [Glossary]({{ '/guide/glossary' | relative_url }}) or to another page in the guide whenever possible. If information isn't available, consider linking to a reputable third-party resource.

#### Give tips, not commands
### Give tips, not commands

When giving instruction, stick to broad strokes. They can be adjusted over time to grow with a project and its designer. Overly-detailed instructions could easily get outdated with the next software patch.
When describing solutions, stick to broad strokes. Overly-detailed instructions could easily get outdated with new technical developments.

#### Get the reader involved
### Get the reader involved

The Design Guide is a set of recommended solutions and practices based on our research that should encourage self-sufficient thinking and creativity. Motivate people to think critically and inspire them to come up with their own solutions.

#### Show, don’t tell
### Show, don’t tell

When it's possible, try to provide an example or a visual instead of highly-technical or text-heavy explanation. Feel free to reference other software using screenshots.

Expand All @@ -76,14 +75,14 @@ When it's possible, try to provide an example or a visual instead of highly-tech
*These UTXOs can also be grouped into “clusters” from the individual senders (see diagram)*.
![](assets/images/payments/cluster-options.png)

#### Use the right medium
### Use the right medium

A picture is worth a thousand words, but so are videos, interactive prototypes, diagrams, and more. Don't be afraid to try a different medium if you think it will inform better than text or a picture.

#### Be humble
### Be humble

The guide is a work in progress and needs to evolve to stay relevant. What we write today may not be applicable tomorrow. Have fun. Don't overthink things. Bitcoin, and therefore this guide, is the ultimate work-in-progress.

#### Write in the open
### Write in the open

It's a good idea to ask for directions by seeking feedback early. This may stop you from wandering too far in the wrong direction. There is a whole community around you that's ready to jump in and help.
15 changes: 14 additions & 1 deletion guide/contribute/contribute.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: guide
title: Contribute
title: Contribute to guide
description: Additional material for both readers and writers of the guide.
nav_order: 9
has_children: true
Expand All @@ -16,6 +16,19 @@ This page shows you how to get involved and start contributing.

---

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

We use the #bitcoin-design-guide channel in the [Bitcoin Design Slack community]({{ site.slack_invite_url }}) to communicate and discuss work on guide. To hear what is going on, see what you can help with, or suggest new contributions please come and say hi.

---

**[Github](https://github.com/BitcoinDesign/Guide)**

We use Github to host the content of the guide. [Issues](https://github.com/BitcoinDesign/Guide/issues) are used to post ideas for improvements, and proposed changes are posted as [Pull Requests](https://github.com/BitcoinDesign/Guide/pulls).
For some ideas we use [Discussions](https://github.com/BitcoinDesign/Guide/discussions).

---

**[Content guidelines]({{ '/guide/contribute/content-guidelines/' | relative_url }})**

Tips on how to write for the guide, with the goal of achieving a consistent tone across all pages.
Expand Down
8 changes: 5 additions & 3 deletions guide/contribute/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ layout: guide
title: Formatting
description: Visual examples of formatting options available for content authors.
nav_order: 11
parent: Contribute
parent: Contribute to guide
permalink: /guide/contribute/formatting/
image: /assets/images/guide/contribute/formatting-preview.jpg
---

# Formatting

This page showcases the various formatting and layout options available for content. This allows editors to better understand their toolbox and access reference code. It also allows for designers to see the design system in one place. The design source file is a public Figma community file you can find [here](https://www.figma.com/community/file/862622015964353400/Bitcoin-Designers-site). To improve the design, please start with the Figma file and make a proposal in Slack or Github before implementing.
This page showcases the various formatting and layout options available for content. This allows editors to better understand their toolbox and access reference code. It also allows for designers to see the design system in one place.

The design source file is a public Figma community file you can find [here](https://www.figma.com/community/file/862622015964353400/Bitcoin-Designers-site). To improve the design, please start with the Figma file and make a proposal in Slack or Github before implementing.


## Basic markdown formatting
Expand Down Expand Up @@ -74,7 +76,7 @@ There should be whitespace between paragraphs.

### Images

Let's start with a very wide image that extends beyond the content with on desktops. Note how a different images is shown on mobile. This can be used to reformat image content to a portrait format.
Let's start with a very wide image that extends beyond the content width on desktops. Note how a different image is shown on mobile. This can be used to reformat image content to a portrait format.

{% raw %}
```liquid
Expand Down