From a14d810b9bf9f4f0ed7aae38a397b57e630f73be Mon Sep 17 00:00:00 2001
From: Ulyana <ulyana@cleanlab.ai>
Date: Fri, 2 Dec 2022 11:58:51 -0800
Subject: [PATCH] Shorten tutorial titles in docs for readability (#553)

Co-authored-by: Jonas Mueller <1390638+jwmueller@users.noreply.github.com>
---
 docs/README.md        |  6 +++---
 docs/source/index.rst | 28 ++++++++++++++--------------
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 1d036dcce1..20af7d5447 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -75,7 +75,7 @@ pip install -r docs/requirements.txt
 
    2. move the notebook to ignore from local build to the newly created folder
    ```
-   mv docs/source/tutorials/audio.ipynb ../ignore_notebooks 
+   mv docs/source/tutorials/audio.ipynb ../ignore_notebooks
    ```
 
    3. build the docs locally, using `sphinx-build` as it does not require you to commit your changes
@@ -282,9 +282,9 @@ instead of containing your own virtualenv in there. CI will FAIL if you instead
    - Add a comment in hidden cell not displayed on docs.cleanlab.ai stating which version of dependencies you used.
    - Think carefully whether each dependency is really necessary and if its future versions will be stable / compatible with future versions of existing dependencies.
 
-6. Don't forget to update **docs/source/index.rst** and **docs/source/tutorials/index.rst** to ensure your tutorial properly linked. Otherwise it will not appear on docs.cleanlab.ai!
+6. Don't forget to update **docs/source/index.rst** with a short title and **docs/source/tutorials/index.rst** to ensure your tutorial properly linked. Otherwise it will not appear on docs.cleanlab.ai!
 
-7. Ask yourself: 
+7. Ask yourself:
 - How can I make this tutorial run faster without sacrificing educational value?  Perhaps use smaller subsample of the dataset, smaller/pretrained model, etc.
 - What sections of this tutorial are least vital?  Consider creating a separate [Examples](https://github.com/cleanlab/examples) notebook that features those.
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
index ea406eb1fa..bb36ac8a0c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -97,7 +97,7 @@ The example below shows how to view all dataset-level issues in one line of code
    health_summary(labels, pred_probs, class_names=class_names)
 
 
-Contributing 
+Contributing
 ------------
 
 As cleanlab is an open-source project, we welcome contributions from the community.
@@ -114,18 +114,18 @@ Please see our `contributing guidelines <https://github.com/cleanlab/cleanlab/bl
    :hidden:
    :caption: Tutorials
 
-   tutorials/indepth_overview
-   tutorials/image
-   tutorials/text
-   tutorials/tabular
-   tutorials/audio
-   tutorials/dataset_health
-   tutorials/outliers
-   tutorials/multiannotator
-   tutorials/multilabel_classification
-   tutorials/token_classification
-   tutorials/pred_probs_cross_val
-   tutorials/faq
+   Workflows of Data-Centric AI <tutorials/indepth_overview>
+   Image Classification (pytorch) <tutorials/image>
+   Text Classification (tensorflow) <tutorials/text>
+   Tabular Classification (sklearn) <tutorials/tabular>
+   Audio Classification (speechbrain) <tutorials/audio>
+   Find Dataset-level Issues <tutorials/dataset_health>
+   Identifying Outliers (pytorch) <tutorials/outliers>
+   Improving Consensus Labels for Multiannotator Data <tutorials/multiannotator>
+   Multi-Label Classification <tutorials/multilabel_classification>
+   Token Classification (text) <tutorials/token_classification>
+   Predicted Probabilities via Cross Validation <tutorials/pred_probs_cross_val>
+   FAQ <tutorials/faq>
 
 .. toctree::
    :caption: API Reference
@@ -148,7 +148,7 @@ Please see our `contributing guidelines <https://github.com/cleanlab/cleanlab/bl
 .. toctree::
    :caption: Guides
    :hidden:
-   
+
    How to contribute <https://github.com/cleanlab/cleanlab/blob/master/CONTRIBUTING.md>
    Migrating to v2.x <migrating/migrate_v2>