From 06900713a943e099c86c3ab5ce7466acfd2ab4fe Mon Sep 17 00:00:00 2001 From: GBKS Date: Thu, 3 Jul 2025 08:39:07 +0200 Subject: [PATCH 1/2] Add a contributor guide around adoption status This is a very lightweight approach to addressing the discussions around whether certain BIPs and other techniques that are very new or highly debated, should be included in the guide. It's a short paragraph at the end of the Content guidelines page in the Contribute section. Closes #1101 --- guide/contribute/content-guidelines.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/guide/contribute/content-guidelines.md b/guide/contribute/content-guidelines.md index 817f73c6c..62aaab658 100644 --- a/guide/contribute/content-guidelines.md +++ b/guide/contribute/content-guidelines.md @@ -22,6 +22,15 @@ image: https://bitcoin.design/assets/images/guide/contribute/content-guidelines/ # Content guidelines +{:.no_toc} +--- + + + +--- 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. @@ -94,6 +103,12 @@ The guide is a work in progress and needs to evolve to stay relevant. What we wr 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. +### Indicate adoption status as needed + +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. + +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 is that your topic should not be included. Also keep in mind that minds can change over time, especially by pragmatically addressing concerns. + --- Now that we've covered general content guidelines, let’s take a closer look at [Illustration guidelines]({{ '/guide/contribute/illustration-guidelines/' | relative_url }}). From 6b8471c781f4383c740c5128a2c0730323ae7430 Mon Sep 17 00:00:00 2001 From: Christoph Ono Date: Wed, 9 Jul 2025 15:05:39 +0200 Subject: [PATCH 2/2] Update guide/contribute/content-guidelines.md --- guide/contribute/content-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/contribute/content-guidelines.md b/guide/contribute/content-guidelines.md index 62aaab658..1e459b73d 100644 --- a/guide/contribute/content-guidelines.md +++ b/guide/contribute/content-guidelines.md @@ -107,7 +107,7 @@ It's a good idea to ask for directions by seeking feedback early. This may stop 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. -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 is that your topic should not be included. Also keep in mind that minds can change over time, especially by pragmatically addressing concerns. +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. ---