search

ChromeDevTools / debugger-protocol-viewer

DevTools Protocol API docs—its domains, methods, and events
https://chromedevtools.github.io/devtools-protocol/
Other
862 stars 172 forks source link

Styling #2

Closed paulirish closed 9 years ago

paulirish commented 9 years ago

With a little time it could look much better. Any suggestions for a API reference style to be inspired from?

kdzwinel commented 9 years ago

JSDoc comes to mind, but it's not exactly beautiful - http://jsdoc.sourceforge.net/example/ . I can create something simple based on http://getskeleton.com/ (same thing I used for EDL).

paulirish commented 9 years ago

https://stripe.com/docs/api is pretty attractive.

auchenberg commented 9 years ago

Github: https://developer.github.com/v3/gists/

Swagger: http://swagger.io/

ericguzman commented 9 years ago

+1 for Stripe's style.

The more I play with Swagger, the sweeter I think it is as a tool, but you have to start digging around to discover this. Stripe's API doc style + response samples laid out elegantly in the same view make it a more approachable style, IMO.

paulirish commented 9 years ago

Yup.

http://readme.io/ came out recently to make the stripe style easy for everyone, but AFAICT, we can't just toss it a JSON and have it stay up to date. (@gkoberger can you confirm? - our docs is basically this file)

gkoberger commented 9 years ago

@paulirish yes and no!

We currently support a few specs (Swagger and APIDoc) where we can auto-generate docs from, and are super interested in adding more. Is the definition in any sort of existing format? Either way, we can probably write some sort of connector for it.

We'd love to help out! (And ReadMe would be free, too, since all this is open source :) )

paulirish commented 9 years ago

​I don't think it currently matches a API spec. Here it is: https://chromium.googlesource.com/chromium/blink/+/master/Source/devtools/protocol.json

We currently display it like this https://chromedevtools.github.io/debugger-protocol-viewer/ but we're ready to explore other options.

Would an adapter for readme.io be much work?

kdzwinel commented 9 years ago

@paulirish Since polymer is in place, should we start using material design elements?

paulirish commented 9 years ago

Sure yah!