[tor-bugs] #29200 [UX]: Make more accessible Core Tor documentation

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

#29200: Make more accessible Core Tor documentation
------------------------+----------------------
     Reporter:  juga    |      Owner:  antonela
         Type:  defect  |     Status:  new
     Priority:  Medium  |  Milestone:
    Component:  UX      |    Version:
     Severity:  Normal  |   Keywords:
Actual Points:          |  Parent ID:
       Points:          |   Reviewer:
      Sponsor:          |
------------------------+----------------------
 There's Core Tor documentation distributed in three (at least) sources.
 Even if it's documentation intended for developers, it'd be great that it
 would be more accessible by providing the HTML version online and using
 some torproject.org subdomain or path or links.
 The sources are:
 - The HTML that can be generated from little-t tor code (with doxygen):
 https://people.torproject.org/~nickm/tor-auto/doxygen/
 - Nickm's torgut repository:
 https://gitweb.torproject.org/user/nickm/torguts.git/tree/. Files are in
 markdown, the can be converted to HTML.
 - The documentation included in little-t tor code:
 https://gitweb.torproject.org/tor.git/tree/doc/HACKING (also markdown).

 I can provide scripts to generate/convert the documentation automatically.
 We would need to decide where to put it, maybe get subdomain and get
 access to the server where it would live.

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

_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs