-
Notifications
You must be signed in to change notification settings - Fork 116
Create Contribute Section #109
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
Merged
Merged
Changes from all commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
815563a
Set up foundation resources vs contribute
pavlenex 21b534c
Update formatting.md
pavlenex d20f22a
add contribute.md
pavlenex f1f2937
Update content-guidelines.md
pavlenex 8f3fb8d
Update contribute.md
pavlenex 411819f
add examples do's and don't
pavlenex e9c56fd
formatting
pavlenex 5b68dd1
replace blockquote with italic styling
pavlenex 14419ee
add example of graphical context
pavlenex 1ee9ded
Add better structure to formatting with examples
pavlenex 242da74
Update formatting.md
pavlenex b931791
re-structure and add lists
pavlenex d3a3f4b
image formatting
pavlenex b1a3643
re-structure
pavlenex f3d0b48
add html tag
pavlenex 4a75454
Update formatting.md
pavlenex 3fb081d
try plaintext
pavlenex 5914984
replace html with markdown
pavlenex d63035d
Update content-guidelines.md
pavlenex b0546b5
better link example
pavlenex b65120b
add yt video instructions
pavlenex 0003c80
liquid raw format, remove encoded img code
pavlenex 8393231
attempt to fix {% raw %}
pavlenex 32664e8
Added Contribute page preview image
GBKS 8ccf00d
Apply suggestions from code review
pavlenex ca2f800
Apply suggestions from code review
pavlenex 5ab024f
Merge branch 'master' into guide-2
pavlenex ae13cf9
Remove Resources.md and img folder
pavlenex 3da8052
add footnote, fix figma, move code block
pavlenex c17ff56
Update formatting.md
pavlenex File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -394,4 +394,4 @@ assets/images/guide/foundations/wallet-interoperability/wallet-interoperability. | |
| assets/images/guide/foundations/wallet-interoperability/wallet-interoperability-mobile.jpg: wallet-interoperability-mobile.jpg | ||
| assets/images/guide/foundations/wallet-interoperability/[email protected]: [email protected] | ||
| assets/images/guide/foundations/wallet-interoperability/wallet-interoperability-preview.jpg: wallet-interoperability-preview.jpg | ||
| assets/images/guide/foundations/foundations-preview.jpg: foundations-preview.jpg | ||
| assets/images/guide/foundations/foundations-preview.jpg: foundations-preview.jpg | ||
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| layout: guide | ||
| title: Content guidelines | ||
| description: Writing tips for authors of the Bitcoin Design Guide. | ||
| nav_order: 10 | ||
| parent: Contribute | ||
| permalink: /guide/contribute/content-guidelines/ | ||
| image: /assets/images/guide/contribute/content-guidelines-preview.jpg | ||
| --- | ||
|
|
||
| # Content guidelines | ||
|
|
||
| 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 | ||
|
|
||
| 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 }}). | ||
|
|
||
| #### 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.* | ||
|
|
||
| ##### 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.* | ||
|
|
||
|
|
||
| #### 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 | ||
|
|
||
| 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 | ||
|
|
||
| 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. | ||
|
|
||
| #### 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 | ||
|
|
||
| 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. | ||
|
|
||
| #### 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 | ||
|
|
||
| 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. | ||
|
|
||
| ##### Do | ||
|
|
||
| *The user’s wallet currently has a balance of 2.845 BTC, and is comprised of 4 UTXOs:* | ||
| * *1 BTC from Ed* | ||
| * *0.5 BTC from Ed* | ||
| * *0.845 BTC from Jane* | ||
| * *0.5 from Joe* | ||
| *These UTXOs can also be grouped into “clusters” from the individual senders (see diagram)*. | ||
|  | ||
|
|
||
| #### 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 | ||
|
|
||
| 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 | ||
|
|
||
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| layout: guide | ||
| title: Contribute | ||
| description: Additional material for both readers and writers of the guide. | ||
| nav_order: 9 | ||
| has_children: true | ||
| permalink: /guide/contribute/ | ||
| image: /assets/images/guide/contribute/contribute-preview.jpg | ||
| --- | ||
|
|
||
| # Contribute to the Guide | ||
|
|
||
| People around the internet build and shape the Bitcoin Design Guide every day. You can be the part of our open community too! | ||
|
|
||
| This page shows you how to get involved and start contributing. | ||
|
|
||
| --- | ||
|
|
||
| **[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. | ||
|
|
||
| --- | ||
|
|
||
| **[Formatting]({{ '/guide/contribute/formatting/' | relative_url }})** | ||
|
|
||
| Layout and formatting options available for content pages, from headers and blockquotes to images and embeds. | ||
|
|
||
| --- | ||
|
|
||
| These contribution guidelines are for the Bitcoin Design Guide project. To get involved with the broader Bitcoin Design community and projects, check out [general contribution guidelines](https://bitcoin.design/contribute/). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.