search

Chicago / opengrid

A user-friendly, map-based tool to combine and explore real-time or historical data.
http://opengrid.io
Other
246 stars 53 forks source link

Improve JSON Formatting in API Documentation #160

Closed seancarroll closed 8 years ago

seancarroll commented 8 years ago

JSON formatting could use some love

tomschenkjr commented 8 years ago

Thanks @seancarroll. Do you have some specific items you were looking for but weren't documented as well?

seancarroll commented 8 years ago

JSON in https://opengrid.readthedocs.org/en/latest/OpenGrid%20API/ can be a wall of unformatted text that could use a bit of formatting to make it easier to understand the structure. Below is an example

screen shot 2016-02-21 at 11 01 06 pm

I think it would be helpful if it was formatted such as the following which I grabbed from http://docs.readthedocs.org/en/latest/api.html

screen shot 2016-02-21 at 11 11 52 pm

I've looked at mkdoc extensions as well as highlightjs but haven't been able to get the desired result yet.

tomschenkjr commented 8 years ago

Thanks!

tomschenkjr commented 8 years ago

@reve0716 - can you look at this and format the JSON? Swing by with any questions.

@rladines - FYI on this.

reve0716 commented 8 years ago

I'm currently formatting the API document.