Skip to content

Commit 7ed087d

Browse files
Merge pull request #1183 from BitcoinDesign/feature/editorial-guide-adoption
Add a content guideline around adoption status
2 parents 1cd2bfb + 6b8471c commit 7ed087d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

guide/contribute/content-guidelines.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@ image: https://bitcoin.design/assets/images/guide/contribute/content-guidelines/
2222

2323

2424
# Content guidelines
25+
{:.no_toc}
26+
---
27+
28+
<nav class="glossary-toc" markdown="1" aria-label="Table of contents">
29+
* Table of contents
30+
{:toc}
31+
</nav>
32+
33+
---
2534

2635
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.
2736

@@ -94,6 +103,12 @@ The guide is a work in progress and needs to evolve to stay relevant. What we wr
94103

95104
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.
96105

106+
### Indicate adoption status as needed
107+
108+
Bitcoin technology keeps evolving, and not all new ideas end up being broadly adopted. Help readers understand what the current maturity and adoption status is, so they can make appropriate decisions in their own products. The [Stabilizing bitcoin value]({{ '/guide/how-it-works/stabilizing-bitcoin-value/' | relative_url }}) page is a good example.
109+
110+
When in doubt, ask the community for an evaluation. While the guide is forward-looking and covers a lot of areas, please also be understanding if the community feedback suggests that your topic should not be included. Also keep in mind that minds can change over time, especially by pragmatically addressing concerns.
111+
97112
---
98113

99114
Now that we've covered general content guidelines, let’s take a closer look at [Illustration guidelines]({{ '/guide/contribute/illustration-guidelines/' | relative_url }}).

0 commit comments

Comments
 (0)