aboutsummaryrefslogtreecommitdiff
path: root/proposals/README_template.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2020-07-27 10:49:51 -0400
committerNick Mathewson <nickm@torproject.org>2020-07-27 10:51:23 -0400
commit246a5864619e2393d447aab5826a990fdef3dfd5 (patch)
tree526e3d47557d1577e49c2d82acf69bca8f530e03 /proposals/README_template.md
parent4c7124a311d6b7930d527a4379f09873b93993ba (diff)
downloadtorspec-246a5864619e2393d447aab5826a990fdef3dfd5.tar.gz
torspec-246a5864619e2393d447aab5826a990fdef3dfd5.zip
Small template and script improvements
Diffstat (limited to 'proposals/README_template.md')
-rw-r--r--proposals/README_template.md35
1 files changed, 26 insertions, 9 deletions
diff --git a/proposals/README_template.md b/proposals/README_template.md
index b8fa7e2..55a913d 100644
--- a/proposals/README_template.md
+++ b/proposals/README_template.md
@@ -1,5 +1,11 @@
# Tor proposals by status
+{warning}
+
+<!-- If you want to make changes here, make sure to edit the -->
+<!-- README_template.md file. The README.md file is generated by the -->
+<!-- reindex.py script. -->
+
Here we have a set of proposals for changes to the Tor protocol. Some
of these proposals are implemented; some are works in progress; and some
will never be implemented.
@@ -9,14 +15,14 @@ Below are a list of proposals sorted by status. See
# Active proposals by status
-## OPEN proposals: Under discussion
+## OPEN proposals: under discussion
These are proposals that we think are likely to be complete, and ripe
for discussion.
{OPEN}
-## ACCEPTED proposals: Slated for implementation
+## ACCEPTED proposals: slated for implementation
These are the proposals that we agree we'd like to implement. They
might or might not have a specific timeframe planned for their
@@ -24,14 +30,14 @@ implementation.
{ACCEPTED}
-## FINISHED proposals: Implemented, specs not merged
+## FINISHED proposals: implemented, specs not merged
These proposals are implemented in some version of Tor; the proposals
themselves still need to be merged into the specifications proper.
{FINISHED}
-## META proposals: About the proposal process
+## META proposals: about the proposal process
These proposals describe ongoing policies and changes to the proposals
process.
@@ -49,19 +55,30 @@ proposed changes in the Tor specifications.
## DRAFT proposals: incomplete works
+These proposals have been marked as a draft by their author or the editors,
+indicating that they aren't yet in a complete form. They're still open for
+discussion.
+
{DRAFT}
-## NEEDS-REVISION proposals: good ideas that we can't implement as-is.
+## NEEDS-REVISION proposals: ideas that we can't implement as-is
+
+These proposals have some promise, but we can't implement them without
+certain changes.
{NEEDS-REVISION}
## NEEDS-RESEARCH proposals: blocking on research
+These proposals are interesting ideas, but there's more research that would
+need to happen before we can know whether to implement them or not, or to
+fill in certain details.
+
{NEEDS-RESEARCH}
# Inactive proposals by status
-## CLOSED proposals: Implemented and specified
+## CLOSED proposals: implemented and specified
These proposals have been implemented in some version of Tor, and the
changes from the proposals have been merged into the specifications as
@@ -69,7 +86,7 @@ necessary.
{CLOSED}
-## RESERVE proposals: Saving for later
+## RESERVE proposals: saving for later
These proposals aren't anything we plan to implement soon, but for one
reason or another we think they might be a good idea in the
@@ -78,14 +95,14 @@ confront the problems that they try to solve.
{RESERVE}
-## SUPERSEDED proposals: Replaced by something else
+## SUPERSEDED proposals: replaced by something else
These proposals were obsoleted by a later proposal before they were
implemented.
{SUPERSEDED}
-## DEAD, REJECTED, OBSOLETE proposals: Not in our plans.
+## DEAD, REJECTED, OBSOLETE proposals: not in our plans
These proposals are not on-track for discussion or
implementation. Either discussion has stalled out (the proposal is