Repository navigation
Add a content guideline around adoption status - #1183
Merged
Merged
Conversation
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
✅ Deploy Preview for bitcoin-design-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
GBKS
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a custom table of contents and a new subsection advising authors to indicate the maturity and adoption status of emerging Bitcoin proposals.
- Insert a
<nav>-based TOC with{:toc}under the main heading. - Add a “Indicate adoption status as needed” guideline at the end of the page.
Comments suppressed due to low confidence (2)
guide/contribute/content-guidelines.md:106
- [nitpick] Verify that this H3 heading is included in the autogenerated TOC or consider using an H2 if it needs more prominence alongside other main sections.
### Indicate adoption status as needed
guide/contribute/content-guidelines.md:25
- [nitpick] The
{:.no_toc}directive may be unnecessary or redundant; please confirm it's required to prevent duplicate table of contents.
{:.no_toc}
swedishfrenchpress
requested changes
Jul 9, 2025
swedishfrenchpress
left a comment
swedishfrenchpress
left a comment
Collaborator
There was a problem hiding this comment.
Small optional readability nit. Otherwise LGTM.
|
|
||
| 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. |
Collaborator
There was a problem hiding this comment.
small nit on readability
"please also be understanding if the community feedback suggests that your topic should not be included."
I had to re-read the original sentence a couple times to understand it. I think this helps make it just a bit clearer.
GBKS
commented
Jul 9, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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.
Also adds a table of contents to that page.
🌿Check the preview🌱
Closes #1101