Reorganize the list of resources in the webapi docs.

Review Request #4805 — Created Oct. 19, 2013 and submitted

Information

Review Board
master

Reviewers

Reorganize the list of resources in the webapi docs.

The webapi docs had a flat, alphabetical list of resources, which wasn't
that easy to navigate. This was especially true since we had things like
"file attachment comments," "review file attachment comments," "review
reply file attachment comments," etc.

Now, all resources in this list are grouped by sections, making it much
easier to locate a particular category of resources and to see how they
relate.

It also deletes file-attachment-comment, which isn't even really a
resource and should never have been there (since the list for that
resource forwards on to the an instance within the parent review in the
tree).

Built the docs and went through them. It was so much easier to navigate.

reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    Ignored Files:
    docs/manual/webapi/2.0/resources/index.txt
    docs/manual/webapi/2.0/resources/file-attachment-comment.txt

  2. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    Ignored Files:
    docs/manual/webapi/2.0/resources/index.txt
    docs/manual/webapi/2.0/resources/file-attachment-comment.txt

  2. 
      
david
  1. Ship It!

  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Loading...