[tor-bugs] #31876 [Circumvention/BridgeDB]: Overhaul BridgeDB's documentation and specification

[Tor Bug Tracker & Wiki]

#31876: Overhaul BridgeDB's documentation and specification
------------------------------------+--------------------------------
 Reporter:  phw                     |          Owner:  juggy
     Type:  task                    |         Status:  assigned
 Priority:  Medium                  |      Milestone:
Component:  Circumvention/BridgeDB  |        Version:
 Severity:  Normal                  |     Resolution:
 Keywords:  s30-o24a4               |  Actual Points:
Parent ID:  #31281                  |         Points:  3
 Reviewer:                          |        Sponsor:  Sponsor30-must
------------------------------------+--------------------------------

Comment (by phw):

 Replying to [comment:2 juggy]:
 > Would it be useful to add a short paragraph to the "So how do I use
 this" section? As a newcomer, it would have been helpful if there had been
 a few sentences on the technologies used and maybe a brief technical
 overview of the source code (how the different major modules are
 connected, etc). I could whip one up for review after going through the
 modules I haven't read yet.
 [[br]]
 Yes, an architectural overview would be very helpful. In fact, you may
 want to add a new section for this because it seems a bit out of scope for
 the "So how do I use this" section. What do you think?
 [[br]]
 > Also, should all references to Python 2 in the instructions under
 "Deploying BridgeDB" also be changed to Python 3?
 [[br]]
 Yes, but we will also have to update the instructions. For example,
 virtual environments are created differently in Python 3.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/31876#comment:3>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online