-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
[air] Refactor Docs for re-emphasizing libraries (3/n) #36912
[air] Refactor Docs for re-emphasizing libraries (3/n) #36912
Conversation
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
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.
Two suggestions for the TOC that could make the organization cleaner, if it makes technical sense to you.
doc/source/_toc.yml
Outdated
- file: ray-air/getting-started | ||
sections: | ||
- file: ray-air/deployment | ||
- file: ray-air/computer-vision |
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.
Suggest moving Computer Vision one level up because it is a Use Case.
doc/source/_toc.yml
Outdated
sections: | ||
- file: ray-air/getting-started | ||
sections: | ||
- file: ray-air/deployment |
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.
Suggest moving this content into Ray for ML Infrastructure to reduce the number of levels.
The only thing I feel is a bit weird is that "Use cases" doesn't have the dropdown caret, but I noticed we fixed this for the "User Guides" subsections now. So it seems inconsistent. If there is the concern users would click the caret, bypassing the landing page, how about making the Caret greyed out / unclickable but visible, or making it visible but clicking it goes to the use cases landing page still? |
@ericl, I think it's fine to add a caret for |
…6912) Signed-off-by: NripeshN <nn2012@hw.ac.uk>
…6912) Signed-off-by: harborn <gangsheng.wu@intel.com>
…6912) Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
…6912) Signed-off-by: Victor <vctr.y.m@example.com>
Why are these changes needed?
This PR makes major structural changes to the TOC, as previously agreed upon (cc @ericl).
In future PR, we will need to:
Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.