[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:     
 Keywords:               |         Parent:     
   Points:               |   Actualpoints:     
-------------------------+--------------------------------------------------
 Christian started reformatting [https://onionoo.torproject.org/ Onionoo's
 protocol specification], which is great!

 Creating this ticket for the discussion.

 So far, Christian made two drafts:

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

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

 Some random comments:

  - It's difficult to compare the two drafts, because the second draft
 doesn't contain field descriptions.

  - Adding an example is probably not necessary.  Instead, we could add a
 link to `/summary?limit=4` for a few actual examples.  Same for the other
 resources.

  - I like the nested tables in the first draft slightly better than
 splitting up documents into 1 document object and 2 objects for relays and
 bridges.

  - The colors, including table borders, look slightly better in the second
 draft.

  - Adding a menu to the left margin is probably overkill.

  - I like both drafts better than the current version, so thanks for
 working on this!

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