webcomponents.org icon indicating copy to clipboard operation
webcomponents.org copied to clipboard

Element-view suggestion

Open LiberQuack opened this issue 8 years ago • 3 comments

I think it's more reasonable to show element documentation prior to element "meta" information first See the screenshot, the reading flow is more convenient and also... it gets more familiar to people who knows npm registry and customelements.io

This is my layout proposal image

This is the actual layout image

LiberQuack avatar Apr 06 '17 23:04 LiberQuack

This was actually the way it used to be.

Please see #840. The gist of it is that navigation is the primary action and needs to be super intuitive. For navigation, top-left is the only one that makes sense, as it affects the content on the right.

What do you think? I know we made a trade-off there.

samuelli avatar Apr 06 '17 23:04 samuelli

Interesting, #839 caught my attention...

Thoughts

I read #840 and I still think it would be better to have the side bar on the right, but I totally agree that having API(s) navigation on the right is a pain. Also, while I was in a hurry today jumping from page to page... I felt some weird feeling about api navigation

My pain points of today in summary:

  • Sometimes I wanted to read the overview, but I stumbled with the side bar catching my attention
  • Sometimes I wanted to read api information only, but I stumbled with side bar and the overview

What if?

  • We move sidebar back to the right
  • Group demos in their own section (on the right)
  • Change api navigation to tabs

I'm not sure enough about tabs... because in some elements there can be too many of them :/, but in terms of reading flow I think it's ok

LiberQuack avatar Apr 07 '17 02:04 LiberQuack

Just another data point: I also find the right-hand​ panel much cleaner and easier to read. The nav is a little obscure, but it is now too.

I would also vote for putting the panel back on the right and iterating just on the nav if need be. Better immediate trade-off IMO.

(FWIW I'd argue that reading the content is the primary action and should be as comfortable as possible)

madeleineostoja avatar Jun 15 '17 19:06 madeleineostoja