-
Notifications
You must be signed in to change notification settings - Fork 157
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
Improve documentation by additional hierarchy #1094
Comments
Yeah, this is a fair criticism. cc @EssamWisam |
Any plans? I know that MLJ is the most complete and best maintained julia meta package for machine learning, but still people just expect that they can go to the documentation and are guided instead of overwhelmed. |
I just saw that the MLJ Home already includes the additional nesting. It should be relatively straightforward to include this extra nesting also in the left menu tree. This would be soo much better :) |
@schlichtanders Until we get to work on that (hopefully soon), I highly recommend that you rely on the categorization found in the homepage of the documentation which should be easy to navigate and understand. |
Just a note that the grouping of topics on the landing page (not the left menu) are not a strict hierarchy, as the same topic can appear under multiple headings. I'm not wedded to this idea but I do find it personally useful. For example, in MLJ, tuning is a model wrapper, so naturally appears under "Composition". But this may be a novelty for new users, who may be more likely to find it under "Meta-algorithms". I wonder if (in addition to adding a heirarchy) we can mitigate the overwhelming experience reported by funnelling new users more aggressively to the "Learn MLJ" page (which has a small link at the top at present). So, on the landing page there could be just 4 very large prominent options: INSTALL Just brainstorming here. Thoughts? |
Just looked at the documentation and was overwhelmed by all the section titles. It is just too much I think.
Maybe someone can create an additional nesting to simplify the navigation of the documentation?
The text was updated successfully, but these errors were encountered: