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
bip 2: allow markdown #1504
bip 2: allow markdown #1504
Conversation
I think this is an acceptable amendment. @luke-jr |
Omg, this would be amazing! Mediawiki just feels so cumbersome compared to markdown. |
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.
Gonna guess this is missing changing buildtable
around this line:
Line 98 in e918b50
my $fn = sprintf "bip-%04d.mediawiki", $bipnum; |
What'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
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. |
Hello, throwing a bunch of questions in the air
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]".
Do you mean which flavor?
Are BIP Comments abandoned? Any other point in discussion about BIP 2? Does it make sense to replace BIP 2 with new process? |
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.
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)." |
@ajtowns points out that the BIP isn't final, so amending it with a minor change like the suggested one seems reasonable. Unless there is active opposition towards this, I propose this is merged. |
Concept ACK. |
Originally BIP-2 disallowed markdown, but markdown formatting was permitted via bitcoin#1504.
wut |
Does #1577 address your concern, @katesalazar? |
Yes, thank you @murchandamus ! |
BIP 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.