search

PolymerElements / iron-component-page

A reusable landing page for elements
36 stars 32 forks source link

Core API navigation is confusing #29

Closed arthurevans closed 7 years ago

arthurevans commented 9 years ago

The drop-down menu in the core docs tends to obscure what's available. Would be much better to have a drawer panel with a menu of available packages/modules/whatever we call them.

The catalog probably wants to do something else here. iron-component-page probably has to support both these use cases (built-in navigation & external navigation).

justinfagnani commented 8 years ago

We need some UX help on this. @tjsavage ?

tjsavage commented 8 years ago

In the short-term it would be nice to do something like this:

api reference

Longer-term we should roll this in with an updated polymer-project.org site.

arthurevans commented 8 years ago

:+1: A simple nav drawer instead of the pulldown would make this much more usable for the Polymer API docs. And, I think, more useable for people documenting their own elements. Just this one change in the short term would be excellent.

For the more general element use case, ideally we'd have some way of navigating both packages and individual elements--as currently designed, iron-component-page only really handles as single "bundle" of elements. The catalog adds some extra logic (but still doesn't nail the navigation IMO, because bundled elements aren't visible from the top level).

arthurevans commented 8 years ago

We just had another report on this (#96). It would be really good to fix this. Can we just fix this?

justinfagnani commented 8 years ago

Working on this now. I'll put up a initial PR soon

aomarks commented 7 years ago

3.0 is published and it's got a side nav much like this.