Reorganize cuml.accel docs#7026
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
This will conflict with #7021. I have a slight preference to merge that one first and fix the conflicts here, but either works. |
This is a first pass at improving our docs organization (mostly targeting cuml.accel). It: - Moves all `cuml.accel` docs under a `cuml-accel` folder, removing the `zero-code-change-*` prefix most of these files had. - Sets up redirects so all old URLs continue to work - Moves the FAQ list out of the main `cuml-accel` page and into its own page. - Simplifies the initial `cuml-accel` page to provide a quickstart example and some pointers into other useful pages for followup. It's less busy now and should hopefully be easier for users to navigate. - Hides the toctrees, these appear in the sidebar already and don't need to take up extra vertical space. - Removes the very long titles from all `cuml.accel` docs pages. The user is already in the `cuml.accel` docs tree, they don't need to see "cuml.accel: Zero Code Change Acceleration" as a title prefix for every page.
|
Conflicts fixed, this is ready for review. |
|
https://downloads.rapids.ai/ci/cuml/pull-request/7026/8fb7da5/docs/cuml/html/cuml-accel/ docs preview for easy access (you need to be on the nvidia VPN to be able to see it) |
|
/merge |
|
I'm mostly good with the changes in this PR except for the "cuml.accel" as the only section header. I think it would be better and looks better to use "Zero Code Change Accelerator" in the section title and then be less repetitive within the body of the text. I can pushup a small PR with that change. |
4 participants
This is a first pass at improving our docs organization (mostly targeting cuml.accel). It:
cuml.acceldocs under acuml-accelfolder, removing thezero-code-change-*prefix most of these files had.cuml-accelpage and into its own page.cuml-accelpage to provide a quickstart example and some pointers into other useful pages for followup. It's less busy now and should hopefully be easier for users to navigate.cuml.acceldocs pages. The user is already in thecuml.acceldocs tree, IMO they don't need to see "cuml.accel: Zero Code Change Acceleration ..." as a title prefix for every page. This makes the sidebar and top bar much more legible.