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

Real URLs. #15

Closed paulirish closed 9 years ago

paulirish commented 9 years ago

We'll need to have permalinks for things. At the very least, domains, but likely domain + method/event too.

I looked briefly at https://erikringsmuth.github.io/app-router/ and it appears the best maintained in this space. ( Not sure that polymer offers something more definitive… ? )

kdzwinel commented 9 years ago

We definitely need URLs for types so that it's easy to jump from property description to the corresponding type (same as in the current docs: https://developer.chrome.com/devtools/docs/protocol/1.1/dom#command-highlightNode ).

kdzwinel commented 9 years ago

Making type/event/method URLs work with current setup turned out to be much more complicated than I thought. Instead of spending time on that, I propose we change the approach a bit:

Pros of this solution:

Cons:

@paulirish what do you think?

paulirish commented 9 years ago

sounds amazing.

we can use master for things and let a bot like h5bp-bot do the compile and push to gh-pages: https://github.com/h5bp/html5boilerplate.com/blob/master/.travis.yml#L5-L32