Skip to content

Add a content guideline around adoption status #1183

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.

Sign up for GitHub

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
swedishfrenchpress merged 2 commits into from
Jul 9, 2025
Merged

Add a content guideline around adoption status #1183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0690071
Add a contributor guide around adoption status
GBKS Jul 3, 2025
6b8471c
Update guide/contribute/content-guidelines.md
GBKS Jul 9, 2025
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
15 changes: 15 additions & 0 deletions guide/contribute/content-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ image: https://bitcoin.design/assets/images/guide/contribute/content-guidelines/


# Content guidelines
{:.no_toc}
---

<nav class="glossary-toc" markdown="1" aria-label="Table of contents">
Comment thread
GBKS marked this conversation as resolved.
Resolved
* Table of contents
{:toc}
</nav>

---

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.

Expand Down Expand Up @@ -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 suggests 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 }}).
Expand Down