diff options
author | Nick Mathewson <nickm@torproject.org> | 2020-04-23 10:43:48 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2020-04-23 10:43:48 -0400 |
commit | 3ada0e7ed37c293b9cf13ade46558d31679e2a05 (patch) | |
tree | 6248b0f177753015809add6b148b60cd3d31cd13 /proposals/314-allow-markdown-proposals.md | |
parent | 47b495f5f0f4c936cb89055d646885e640be4c47 (diff) | |
download | torspec-3ada0e7ed37c293b9cf13ade46558d31679e2a05.tar.gz torspec-3ada0e7ed37c293b9cf13ade46558d31679e2a05.zip |
Add proposal 314 (markdown) and 315 (required fields.)
Also tweak reindex.py under the assumption that we will be accepting
proposal 314.
Diffstat (limited to 'proposals/314-allow-markdown-proposals.md')
-rw-r--r-- | proposals/314-allow-markdown-proposals.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/proposals/314-allow-markdown-proposals.md b/proposals/314-allow-markdown-proposals.md new file mode 100644 index 0000000..2d2f653 --- /dev/null +++ b/proposals/314-allow-markdown-proposals.md @@ -0,0 +1,38 @@ +``` +Filename: 314-allow-markdown-proposals.md +Title: Allow Markdown for proposal format. +Author: Nick Mathewson +Created: 23 April 2020 +Status: Open +``` + +# Introduction + +This document proposes a change in our proposal format: to allow +Markdown. + +## Motivation + +Many people, particularly researchers, have found it difficult to +write text in the format that we prefer. Moreover, we have often +wanted to add more formatting in proposals, and found it nontrivial +to do so. + +Markdown is an emerging "standard" (albeit not actually a +standardized one), and we're using it in several other places. It +seems like a natural fit for our purposes here. + +# Details + +We should pick a particular Markdown dialect. "CommonMark" seems like a +good choice, since it's the basis of what github and gitlab use. + +We should also pick a particular tool to use for validating Markdown +proposals. + +We should continue to allow text proposals. + +We should continue to require headers for our proposals, and do so +using the format at the head of this document: wrapping the headers +inside triple backticks. + |