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
New glossary terms #1610
New glossary terms #1610
Conversation
f9a2355
to
6d2dcee
Compare
I think it would be best to combine all the node entries into a single entry ( I'm also mildly opposed to adding the UASF and MASF entries since we don't go into the details of either miner signaling nor flag days in the developer documentation, which is what this glossary primarily serves. For example, I think it's particularly important to make clear that all successful forks, not just UASFs, are ultimately enforced by users and for that I think we need more text written and at least one link to be provided in the links section of each entry. Block size limit should probably link to https://bitcoin.org/en/developer-reference#serialized-blocks , which is where we describe the rule in our documentation. This patch should fix this CI error: diff --git a/_includes/devdoc/bitcoin-core/rpcs/rpcs/listbanned.md b/_includes/devdoc/bitcoin-core/rpcs/rpcs/listbanned.md
index ba33c7da..3242587b 100644
--- a/_includes/devdoc/bitcoin-core/rpcs/rpcs/listbanned.md
+++ b/_includes/devdoc/bitcoin-core/rpcs/rpcs/listbanned.md
@@ -48,7 +48,7 @@ The `listbanned` RPC {{summary_listBanned}}
- n: "→ →<br>`ban_reason`"
t: "string"
p: "Required<br>(exactly 1)"
- d: "Set to one of the following reasons:<br> `node misbehaving` if the node was banned by the client because of DoS violations<br> `manually added` if the node was manually banned by the user"
+ d: "Set to one of the following reasons:<br> `node misbehaving`<!--noref--> if the node was banned by the client because of DoS violations<br> `manually added` if the node was manually banned by the user"
{% enditemplate %} |
6d2dcee
to
a96dceb
Compare
I removed the archival node, pruned node, and full node terms. Instead I added an extra description in the devguide under the intro for the P2P network section. I added the link for block size limit. I'm not sure about what to do with UASF and MASF. Maybe add something here: https://bitcoin.org/en/developer-guide#consensus-rule-changes ? |
645dfb2
to
b7b46c8
Compare
Added a node glossary term Added descriptions of full nodes, archival nodes, and pruned nodes to the dev guide. Linked the term "peer" to node instead of original location.
b7b46c8
to
07d3f7d
Compare
07d3f7d
to
8619bde
Compare
@achow101 thanks for the updates! The node and block size commits LGTM (but I haven't previewed yet). For the xASF commit, I think that's the right place for it. Maybe something like the following text just above the final paragraph in that section that begins with "Resources".
Note I put the two links above inside code tics here so that GitHub Markdown renders them for you to copy/paste, but they should be just in regular text in the doc so they get turned into links. Also, I haven't previewed that change myself; the tests should catch it if it doesn't render properly or if the link is broken, but somebody should preview it just to be sure. |
Updated with paragraphs describing UASFs and MASFs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nitpick, otherwise untested ACK.
preset time or block height. Such forks activated via a flag day are known as | ||
[User Activated Soft Forks][/en/glossary/uasf]{:#term-uasf}{:.term} (UASF) as | ||
they are dependent on having sufficient users (nodes) to enforce the new rules | ||
after the flag day. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure BIP16 is a good example of a flag day activation, given that it had explicit miner voting as a prerequisite, even though I think the measurement was performed outside the node code and then a flag day was coded in rather than using the later ISM method. Maybe just mention BIP30?
f8089db
to
f2d403f
Compare
Added the following new glossary terms:
Full nodeArchival nodePruned nodeCloses #1605, #1539, #1240
If this is accepted, please pay the bounty to 1AjFwHanPewurVms4Z3ExtapHmKWF6aTVS