bip 2: allow markdown #1504
pull achow101 wants to merge 1 commits into bitcoin:master from achow101:allow-markdown changing 1 files +1 −1-
achow101 commented at 2:01 am on October 11, 2023: memberBIP authors should be allowed to write their BIPs in Markdown. The MediaWiki syntax that GitHub uses appears to be entirely undocumented (it does not always match mediawiki’s documentation) which makes writing complex BIPs rather difficult. Markdown is much simpler and more concise.
-
bip 2: allow markdown 1a629a4961
-
Roasbeef commented at 11:25 pm on October 16, 2023: contributor
Omg, this would be amazing!
Mediawiki just feels so cumbersome compared to markdown.
-
guggero approved
-
katesalazar changes_requested
-
katesalazar commented at 4:42 pm on October 17, 2023: contributor
Gonna guess this is missing changing
buildtable
around this line: https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/scripts/buildtable.pl#L98What’s the workflow of the bitcoin.it webmaster once this is merged? Would you merge this if a compiler is needed and missing and no workaround is suggested? See: https://en.bitcoin.it/wiki/Category:BIP
Concept ACK
-
bitcoin deleted a comment on Oct 19, 2023
-
luke-jr commented at 0:35 am on October 25, 2023: member
BIP 1 supported markdown, but it was removed in BIP 2. I forget why - maybe simply lack of real-world usage?
Markdown does certainly seem more popular than mediawiki format these days.
Amending BIP 2 seems like an unclear proposition, however. First, someone needs to establish that there’s some kind of consensus from participants, and secondly that amending Final BIPs isn’t technically correct.
-
katesalazar commented at 3:23 pm on October 25, 2023: contributor
Hello, throwing a bunch of questions in the air
BIP 1 supported markdown, but it was removed in BIP 2. I forget why - maybe simply lack of real-world usage?
Note (from Wikipedia) “The initial description of Markdown[10] contained ambiguities and raised unanswered questions, causing implementations to both intentionally and accidentally diverge from the original version. This was addressed in 2014 when long-standing Markdown contributors released CommonMark, an unambiguous specification and test suite for Markdown.[11]”.
Markdown does certainly seem more popular than mediawiki format these days.
Do you mean which flavor?
Amending BIP 2 seems like an unclear proposition, however. First, someone needs to establish that there’s some kind of consensus from participants, and secondly that amending Final BIPs isn’t technically correct.
Are BIP Comments abandoned? Any other point in discussion about BIP 2? Does it make sense to replace BIP 2 with new process?
-
ajtowns commented at 6:20 pm on October 27, 2023: contributor
Amending BIP 2 seems like an unclear proposition, however.
Why not just mark BIP 2 as “replaced/obsolete” and put the policy for this repo in PROCESS.mediawiki with that just being documentation for what this repo’s maintainers’ current policies are? Saying “we can’t update the process to be efficient because the process requires us to be inefficient” is ridiculous.
amending Final BIPs isn’t technically correct.
BIP 2 is marked as “Active”, not “Final”, for whatever that’s worth. BIP 1 described that as “Some Informational and Process BIPs may also have a status of “Active” if they are never meant to be completed. E.g. BIP 1 (this BIP).”
-
darosior commented at 4:10 pm on December 17, 2023: memberConcept ACK.
-
kallewoof merged this on Dec 18, 2023
-
kallewoof closed this on Dec 18, 2023
-
murchandamus referenced this in commit 0092a4318f on Apr 4, 2024
-
katesalazar commented at 9:27 pm on April 23, 2024: contributorwut does this mean, first BIP written in Markdown has to ship the necessary changes in buildtable.pl? can we do the things in the correct order
-
murchandamus commented at 1:32 pm on April 29, 2024: contributorDoes #1577 address your concern, @katesalazar?
-
katesalazar commented at 10:10 pm on May 3, 2024: contributorYes, thank you @murchandamus !
This is a metadata mirror of the GitHub repository bitcoin/bips. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-10-31 23:10 UTC
More mirrored repositories can be found on mirror.b10c.me