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

Order of components in Docs #185

Open
timwienk opened this issue Nov 12, 2014 · 2 comments
Open

Order of components in Docs #185

timwienk opened this issue Nov 12, 2014 · 2 comments

Comments

@timwienk
Copy link
Member

timwienk commented Nov 12, 2014

The order of all components of a project in the Docs is currently alphabetically. In the old website the documented components were separated by subject and the order was manually set up. I don't know if this is something we'd want to bring back, but it does seem easier to use than the current alphabetic list.

If we want to bring it back, maybe a docs.yml or docs.json file in the project repo to facilitate this?

Example from Core docs from old website:
docs-core


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@lorenzos
Copy link

+1. For me the old sorting is far more comfortable than the new one. That, by the way, is only partial alphabetically: it looks like Types and Utilities classes are places on the bottom (I guess because they are sorted by the words Types and Utilities instead of class names), and for me this partial sorting is absolutely confusing.

@SergioCrisostomo
Copy link
Member

Should we add also the titles like Core, Types or Browser as in the image above (left aligned), or just fix the order of the components?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants