[tor-commits] [torspec/main] bridgedb-spec: Add 'Table of contents'

[dgoulet at torproject.org]

commit 686be04ce55da073a788aa99691c527b4c72203d
Author: Oleh Franchuk <0x00.gear at gmail.com>
Date:   Wed Aug 25 16:26:11 2021 +0300

    bridgedb-spec: Add 'Table of contents'
---
 bridgedb-spec.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/bridgedb-spec.txt b/bridgedb-spec.txt
index a4c4708..5ccce92 100644
--- a/bridgedb-spec.txt
+++ b/bridgedb-spec.txt
@@ -4,6 +4,21 @@
                              Karsten Loesing
                               Nick Mathewson
 
+Table of Contents
+
+    0. Preliminaries
+    1. Importing bridge network statuses and bridge descriptors
+        1.1. Parsing bridge network statuses
+        1.2. Parsing bridge descriptors
+        1.3. Parsing extra-info documents
+    2. Assigning bridges to distributors
+    3. Giving out bridges upon requests
+    4. Selecting bridges to be given out based on IP addresses
+    5. Selecting bridges to be given out based on email addresses
+    6. Selecting unallocated bridges to be stored in file buckets
+    7. Displaying Bridge Information
+    8. Writing bridge assignments for statistics
+
 0. Preliminaries
 
    This document specifies how BridgeDB processes bridge descriptor files