Please improve the navigation on *jqueryui.com.
GSPP opened this issue · 6 comments
Navigation is so unintuitive that I'm taking the time to write this issue. I often find myself to be helpless to find the page I want.
- On http://api.jqueryui.com/autocomplete/ I can't reach the samples (http://jqueryui.com/autocomplete/).
- On the samples page (http://jqueryui.com/autocomplete/) the link to the documentation is hidden in text that nobody reads.
- When on http://jqueryui.com/autocomplete/ I find it quite hard to find out how to actually use jQuery UI. Clicking "API Documentation" leads to a maze of links that lead nowhere. The only way to reach the page is the start page (http://jqueryui.com/), then clicking "getting started guide" which is burried in text that nobody reads.
In case you think "you need to read the text": Users should not need to read the text for basic use cases.
My suggestion: Make all pages into a tree and show the tree on the left at all times. Don't create any "clever" or contextual navigation. Just show the tree of pages at all times.
Sorry, but a full page site tree will never make it into the sidebar. If you'd like to provide other suggestions, we can discuss. But a single issue for revamping all navigation and cross-linking isn't helpful.
Alright, scratch that suggestion. Instead I request that you fix these significant problems in any way you see fit. For example, there could be a per-widget tree in the sidebar. That's probably small enough.
What is your opinion on this? You have closed the issue based on the fact that my suggestion is not possible to implement (I agree). But are you not agreeing that the navigation is not good as it stands?
I don't think doing nothing is the right choice here.
On http://api.jqueryui.com/autocomplete/ I can't reach the samples (http://jqueryui.com/autocomplete/).
See jquery/api.jqueryui.com#176
On the samples page (http://jqueryui.com/autocomplete/) the link to the documentation is hidden in text that nobody reads.
Suggestions? Would it help if we move the link above the iframe?
When on http://jqueryui.com/autocomplete/ I find it quite hard to find out how to actually use jQuery UI.
That's fairly vague about what you're trying to figure out. Without more info, we can't possibly lead you to the right place. Are you looking for intro material such as http://learn.jquery.com/jquery-ui/, are you looking for API docs, are you looking for a list of components?
Clicking "API Documentation" leads to a maze of links that lead nowhere.
It leads to the home page of api.jqueryui.com. From there you can use the navigation links in the sidebar or use the search.
The only way to reach the page is the start page (http://jqueryui.com/), then clicking "getting started guide" which is burried in text that nobody reads.
Surely we can't link to the getting started guide from every page. Do you have reasonable suggestions for this? Do you have other projects that you can link to that provide better navigation to such material from a demo page?
Here's a sketch for the autocomplete navigation:
Here's something for the API site:
Changes are marked. Just put all important pages on the left and pin them there so that they are visible on all pages. Context based navigation can be quite confusing. It's a means of last resort if space runs out.
Surely we can't link to the getting started guide from every page.
Why not? I'd do just that. People come mainly through Google and they enter the site at random pages. There is little drawback to having important pages always in the menu.
I find it more questionable to always show the versions and feature areas e.g. on http://api.jqueryui.com/category/widgets/.
What's the status of this? The navigation remains unintuitive. Issue (2) has become worse: The demos link has disappeared entirely.
Go to http://api.jqueryui.com/autocomplete/ and try to:
- Notice, that demos even exist
- Find the demos
You will fail at at both. Does the team consider this an adequate navigation?
This issue is actionable. Your actions, in my mind, should be: notice that all 3 problems exist (or say why they don't), make a plan how to fix them which is not too hard, implement that plan.
An example for good documentation was requested. I think https://simpleinjector.readthedocs.io/en/latest/index.html is really nice. Mainly, because it is so easy to see what documents are available. You don't get lost.