[tor-bugs] #9414 [Onionoo]: Reformat Onionoo's protocol specification to be more useful

[Tor Bug Tracker & Wiki]

#9414: Reformat Onionoo's protocol specification to be more useful
-----------------------------+-----------------
     Reporter:  karsten      |      Owner:
         Type:  enhancement  |     Status:  new
     Priority:  normal       |  Milestone:
    Component:  Onionoo      |    Version:
   Resolution:               |   Keywords:
Actual Points:               |  Parent ID:
       Points:               |
-----------------------------+-----------------

Comment (by karsten):

 Christian made a third draft:

  - http://rndm.de/lab/onionoo-docs/draft3.html

 Some comments:

  - The "Summary Document" part looks really good.  This could be the
 template for the other three document types.

  - Can you write "field name - field type - required/optional" in that
 order?  The field name is what we care most about, then comes the type,
 and then the required/optional bit.

  - Can you indent objects like those in the relays array about twice as
 much as it's the case now?  Right now, the columns appear slightly off,
 but it should become obvious that the "n", "f", "a", and "r" fields are on
 another level than "relays".

  - The "r" field in both the relays and the bridges objects is a bool or
 boolean type, not a string.  I can fix such things later on.  In fact,
 feel free to leave the types blank if you're unsure, and I'll fill in the
 types.

 So, these are all minor remarks.  Would you want to send me a (git-
 formatted) patch to
 https://gitweb.torproject.org/onionoo.git/blob/HEAD:/web/index.html, and I
 clean it up from there?  That would be awesome!

 Thanks!

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