-
Notifications
You must be signed in to change notification settings - Fork 20
✨ Attempt to improve tutorial names and descriptions #232
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
Conversation
Side note: I noticed that back when I made tags assignment, I erroneously replaced "Data Basics" names/links with "Getting Started" ones. This was fixed here (tags were still correct). Sorry for this. |
MLJ.webmThe longer names make the site seem a little busier but I think it's okay after I reduced the weight of the used font. The major advantage is that an informative name given a clear idea of whether one should click on the tutorial or not.
|
Co-authored-by: Anthony Blaom, PhD <anthony.blaom@gmail.com>
Co-authored-by: Anthony Blaom, PhD <anthony.blaom@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great improvement, thanks 🙏🏾
Just those few suggestions. Merge when ready.
Co-authored-by: Anthony Blaom, PhD <anthony.blaom@gmail.com>
All good to go. Merge when ready. |
Moved two tutorials. Merging now. |
In response to significant demand from the audience (me) in #231 and #221 and as discussed with @ablaom, I have made a PR with suggestions for better "informative" names and descriptions for the tutorials.
The idea is that it makes one feel better to good idea about what the tutorial will be about before clicking on it. It's been noted that other machine learning packages, e.g., outside of Julia, also tend to use verbose names for their tutorials.
As for the descriptions, I found that it's optimal to resort to using "intended learning outcomes" as the tutorial descriptors for the two following reasons:
Note that in later tutorials, I did not write the ILOs in a detailed way because such details were covered in the ILOs of earlier tutorials (e.g., coercing data).
Feel free to suggest even better names or ILOs (or to ditch the ILO idea; it's easy to convert them to descriptions; even automatically).
Note that tutorial names will also have to be updated in the Julia file for each tutorial. However, we can move on to this only when the tutorial names, as shown in the JSON object won't further change in the PR.
Lastly, I know I will do some style changes to accomodate the longer names (e.g., navigation button in the bottom has to be longer now, etc.)