Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues with UX in documentation #2112

Closed
dalgard opened this issue Aug 30, 2014 · 2 comments
Closed

Issues with UX in documentation #2112

dalgard opened this issue Aug 30, 2014 · 2 comments

Comments

@dalgard
Copy link

dalgard commented Aug 30, 2014

Ionic is quite nicely documented, comparatively. The reference pages are very clean and beautiful to look at – the descriptions are quite concise and to the point, which is good, and they have live examples, which is great. Well done :)

(1)
However – it wasn't until I stumbled upon http://learn.ionicframework.com that I really began to understand the details of how to use the different directives and classes – in addition to various general concepts of the framework. That section is a fantastic resource and deserves high praise. Only – I wish I had found it much, much earlier.

I haven't managed to find a single link to that section besides the one in the footer. Obviously, I think it ought to be put front and center several places in the documentation.

(2)
Which brings me to another issue. For some reason, when I want to look up something in the docs, I initially end up in the wrong place before finding what I need. It mainly happens when I try to find some page other than the main CSS or JavaScript reference pages – and each time I get slightly baffled, since I consider myself quite the navigator ;)

It seems as if the site structure is not entirely logical and/or hard to coerce into a mental representation. When trying to narrow it down, one simple point emerges above other things:

The landing pages do not have their own entries in the side menu. In fact, the same goes for some subpages which can only be reached from a landing page. Links leading to landing pages only exist in places outside the context they serve and, by consequence, they seem to be loosely coupled.

.
I hope you'll consider these issues. Thanks.

@perrygovier
Copy link
Contributor

Hey @dalgard,
1 - I agree. I'll run it by those with an opinion on design and find a way to make it more prominent.
2 - This one's more abstract, but I'll see what I can do.

Stay tuned.

@dalgard
Copy link
Author

dalgard commented Oct 1, 2014

(2) I understand what you mean, but I think I pinpointed a least one or two reasonably concrete issues.

I'll stay tuned :)

@Ionitron Ionitron removed the ready label Jan 25, 2015
@ionitron-bot ionitron-bot bot locked and limited conversation to collaborators Sep 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants