Opened 13 months ago

Last modified 4 months ago

#31876 assigned task

Overhaul BridgeDB's documentation and specification

Reported by: phw Owned by: juggy
Priority: Medium Milestone:
Component: Circumvention/BridgeDB Version:
Severity: Normal Keywords: s30-o24a4
Cc: phw, cohosh Actual Points:
Parent ID: #31281 Points: 3
Reviewer: Sponsor: Sponsor30-must

Description

BridgeDB's documentation is slightly outdated and its specification is severely outdated. It's time to update both.

Child Tickets

Change History (4)

comment:1 Changed 7 months ago by pili

Owner: set to juggy
Status: newassigned

comment:2 Changed 7 months ago by juggy

Made a few changes to README (https://github.com/jugheadjones10/bridgedb/tree/docfix).

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.

Also, should all references to Python 2 in the instructions under "Deploying BridgeDB" also be changed to Python 3?

comment:3 in reply to:  2 Changed 7 months ago by phw

Replying to 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.


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?

Also, should all references to Python 2 in the instructions under "Deploying BridgeDB" also be changed to Python 3?


Yes, but we will also have to update the instructions. For example, virtual environments are created differently in Python 3.

comment:4 Changed 4 months ago by cohosh

Cc: cohosh added

cohosh cc'ing myself on sponsor 30 work

Note: See TracTickets for help on using tickets.