aboutcode-org · chinyeungli · Jul 14, 2025 · Jul 14, 2025 · Jul 14, 2025 · Jul 15, 2025
diff --git a/README.rst b/README.rst
@@ -119,10 +119,10 @@ Other Important Documentation Pages:
 - A `synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
   of ScanCode command line options.
 
-- Tutorials on:
+- How-Tos on:
 
-  - `How to run a scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
-  - `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
+  - `Run a scan <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_run_a_scan.html>`_
+  - `Visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_visualize_scan_results.html>`_
 
 - An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
 
@@ -171,7 +171,7 @@ After ScanCode is installed successfully you can run an example scan printed on
 
     scancode -clip --json-pp - samples
 
-Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
+Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_run_a_scan.html>`_
 tutorial to perform a basic scan on the ``samples`` directory distributed by
 default with ScanCode.
 
@@ -180,8 +180,8 @@ See more command examples::
     scancode --examples
 
 See `How to select what will be detected in a scan
-<https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
-and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_
+<https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_set_what_will_be_detected_in_a_scan.html>`_
+and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_format_scan_output.html>`_
 for more information.
 
 You can also refer to the `command line options synopsis
@@ -203,7 +203,7 @@ directory::
     ./extractcode mytar.tar.bz2
 
 See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_
-and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
+and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_extract_archives.html>`_ for details.
 
 
 Support

diff --git a/docs/source/cli-reference/simple-examples.rst b/docs/source/cli-reference/simple-examples.rst
@@ -1,3 +1,3 @@
 .. _how_to_run_a_scan:
 
-.. include::  /tutorials/how_to_run_a_scan.rst
+.. include::  /how-to-guides/how_to_run_a_scan.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,7 +18,9 @@
 # -- Project information -----------------------------------------------------
 
 project = "ScanCode-Toolkit"
-copyright = "nexB Inc. and others."
+copyright = "nexB Inc. and others." + \
+            "Except where otherwise noted, this documentation is " + \
+            "licensed under a cc-by-4.0"
 author = "AboutCode.org authors and contributors"
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/getting-started/home.rst b/docs/source/getting-started/home.rst
@@ -135,4 +135,12 @@ audit function as they like on their own.
 
 Thank you for giving ScanCode a try!
 
+
+License
+-------
+ScanCode is licensed under Apache-2.0 and others. Datasets contributed is
+subject to CC-BY-4.0. See `License
+<https://github.com/aboutcode-org/scancode-toolkit?tab=readme-ov-file#license>`_
+for details.
+
 .. include::  /rst_snippets/other_imp_doc.rst
diff --git a/docs/source/getting-started/install.rst b/docs/source/getting-started/install.rst
@@ -423,6 +423,10 @@ For more information on Python virtualenv, visit this
     no default dependencies on pre-built binaries. This may come handy for some
     special use cases such as packaging for a Linux or FreeBSD distro.
 
+.. NOTE::
+
+  Refer :ref:`run_as_library` for usage samples.
+
 
 To uninstall, run::
 

diff --git a/docs/source/getting-started/newcomer.rst b/docs/source/getting-started/newcomer.rst
@@ -115,19 +115,19 @@ Use ScanCode Better
 All Tutorials/How-Tos
 ^^^^^^^^^^^^^^^^^^^^^
 
-The Tutorials are:
+The How-To's are:
 
 #. :ref:`how_to_run_a_scan`
 #. :ref:`how_to_visualize_scan_results`
-#. :ref:`how_to_set_what_scan_detects`
 #. :ref:`how_to_extract_archives`
 #. :ref:`how_to_specify_output_format`
-#. :ref:`how_to_add_post_scan_plugin`
-
-The How-To's are:
-
+#. :ref:`how_to_set_what_scan_detects`
 #. :ref:`add_new_license_for_det`
 #. :ref:`add_new_license_det_rule`
+#. :ref:`install_new_license_plugin`
+#. :ref:`generate_attribution`
+#. :ref:`how_to_add_post_scan_plugin`
+
 
 .. _newcomer_whats_new:
 

diff --git a/docs/source/how-to-guides/add_new_license.rst b/docs/source/how-to-guides/add_new_license.rst
@@ -1,7 +1,7 @@
 .. _add_new_license_for_det:
 
-How To Add a New License for Detection
-======================================
+Add a New License for Detection
+===============================
 
 How to add a new license for detection?
 ---------------------------------------

diff --git a/docs/source/how-to-guides/add_new_license_detection_rule.rst b/docs/source/how-to-guides/add_new_license_detection_rule.rst
@@ -1,7 +1,7 @@
 .. _add_new_license_det_rule:
 
-How to Add New License Rules for Enhanced Detection
-===================================================
+Add New License Rules for Enhanced Detection
+============================================
 
 ScanCode relies on license rules to detect licenses. A rule is a simple text
 file containing a license text or notice or mention with YAML frontmatter with data

diff --git a/...urce/tutorials/data/components_sample.gif → .../how-to-guides/data/components_sample.gif b/...urce/tutorials/data/components_sample.gif → .../how-to-guides/data/components_sample.gif
diff --git a/docs/source/tutorials/data/files_sample.png → ...ource/how-to-guides/data/files_sample.png b/docs/source/tutorials/data/files_sample.png → ...ource/how-to-guides/data/files_sample.png
diff --git a/docs/source/tutorials/data/filter_sample.gif → ...urce/how-to-guides/data/filter_sample.gif b/docs/source/tutorials/data/filter_sample.gif → ...urce/how-to-guides/data/filter_sample.gif
diff --git a/...ls/data/scancode-toolkit-dynamic-html.png → ...es/data/scancode-toolkit-dynamic-html.png b/...ls/data/scancode-toolkit-dynamic-html.png → ...es/data/scancode-toolkit-dynamic-html.png
diff --git a/...torials/data/scancode-toolkit-extract.png → ...-guides/data/scancode-toolkit-extract.png b/...torials/data/scancode-toolkit-extract.png → ...-guides/data/scancode-toolkit-extract.png
diff --git a/...rials/data/scancode-toolkit-file-tree.png → ...uides/data/scancode-toolkit-file-tree.png b/...rials/data/scancode-toolkit-file-tree.png → ...uides/data/scancode-toolkit-file-tree.png
diff --git a/...ls/data/scancode-toolkit-filter-chart.png → ...es/data/scancode-toolkit-filter-chart.png b/...ls/data/scancode-toolkit-filter-chart.png → ...es/data/scancode-toolkit-filter-chart.png
diff --git a/...als/data/scancode-toolkit-filter-zlib.png → ...des/data/scancode-toolkit-filter-zlib.png b/...als/data/scancode-toolkit-filter-zlib.png → ...des/data/scancode-toolkit-filter-zlib.png
diff --git a/docs/source/tutorials/data/views_sample.gif → ...ource/how-to-guides/data/views_sample.gif b/docs/source/tutorials/data/views_sample.gif → ...ource/how-to-guides/data/views_sample.gif
diff --git a/...ce/tutorials/data/workbench_dashboard.png → ...ow-to-guides/data/workbench_dashboard.png b/...ce/tutorials/data/workbench_dashboard.png → ...ow-to-guides/data/workbench_dashboard.png
diff --git a/...ource/tutorials/data/workbench_launch.png → ...e/how-to-guides/data/workbench_launch.png b/...ource/tutorials/data/workbench_launch.png → ...e/how-to-guides/data/workbench_launch.png
diff --git a/docs/source/how-to-guides/generate_attribution.rst b/docs/source/how-to-guides/generate_attribution.rst
@@ -1,7 +1,7 @@
 .. _generate_attribution:
 
-How To Generate Attribution from a ScanCode Scan
-================================================
+Generate Attribution from a ScanCode Scan
+=========================================
 
 How To generate attribution from a ScanCode scan?
 -------------------------------------------------

diff --git a/...torials/how_to_add_a_post_scan_plugin.rst → ...-guides/how_to_add_a_post_scan_plugin.rst b/...torials/how_to_add_a_post_scan_plugin.rst → ...-guides/how_to_add_a_post_scan_plugin.rst
diff --git a/...rce/tutorials/how_to_extract_archives.rst → ...how-to-guides/how_to_extract_archives.rst b/...rce/tutorials/how_to_extract_archives.rst → ...how-to-guides/how_to_extract_archives.rst
@@ -1,7 +1,7 @@
 .. _how_to_extract_archives:
 
-How To Extract Archives
-=======================
+Extract Archives
+================
 
 ScanCode-Toolkit provides archive extraction. This command can be used before running a scan over
 a codebase in order to ensure all archives are extracted. Archives found inside an extracted

diff --git a/...e/tutorials/how_to_format_scan_output.rst → ...w-to-guides/how_to_format_scan_output.rst b/...e/tutorials/how_to_format_scan_output.rst → ...w-to-guides/how_to_format_scan_output.rst
@@ -1,7 +1,7 @@
 .. _how_to_specify_output_format:
 
-How to specify ScanCode Output Format
-=====================================
+Specify ScanCode Output Format
+==============================
 
 A basic overview of formatting ScanCode Output is presented here.
 

diff --git a/docs/source/tutorials/how_to_run_a_scan.rst → ...ource/how-to-guides/how_to_run_a_scan.rst b/docs/source/tutorials/how_to_run_a_scan.rst → ...ource/how-to-guides/how_to_run_a_scan.rst
@@ -1,5 +1,5 @@
-How to Run a Scan
-=================
+Run a Scan
+==========
 
 In this simple tutorial example, we perform a basic scan on the ``samples`` directory distributed
 by default with ScanCode.
@@ -17,7 +17,7 @@ Looking into Files
 As mentioned previously, we are going to perform the scan on the ``samples`` directory distributed
 by default with ScanCode-Toolkit. Here's the directory structure and respective files:
 
-.. image::  /tutorials/data/files_sample.png
+.. image::  /how-to-guides/data/files_sample.png
 
 We notice here that the sample files contain a package ``zlib.tar.gz``. So we have to extract the
 archive before running the scan, to also scan the files inside this package.

diff --git a/...o_set_what_will_be_detected_in_a_scan.rst → ...o_set_what_will_be_detected_in_a_scan.rst b/...o_set_what_will_be_detected_in_a_scan.rst → ...o_set_what_will_be_detected_in_a_scan.rst
@@ -1,7 +1,7 @@
 .. _how_to_set_what_scan_detects:
 
-How to set what will be detected in Scan
-========================================
+Set what will be detected in Scan
+=================================
 
 ScanCode allows you to scan a codebase for license, copyright and other interesting information
 that can be discovered in files. The following options are available for detection when using

diff --git a/...torials/how_to_visualize_scan_results.rst → ...-guides/how_to_visualize_scan_results.rst b/...torials/how_to_visualize_scan_results.rst → ...-guides/how_to_visualize_scan_results.rst
@@ -1,7 +1,7 @@
 .. _how_to_visualize_scan_results:
 
-How to Visualize Scan results
-=============================
+Visualize Scan results
+======================
 
 To help visualize the scans, we have a dedicated tool  `ScanCode workbench <https://github.com/nexb/scancode-workbench/>`_  which is a desktop application that allows you to visualize and explore the results of one or more scans. It is a cross-platform application that runs on Windows, Mac OS X and Linux. It is built using the Electron framework and is built using Electron, Typescript & React
 

diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
@@ -6,7 +6,14 @@
 .. toctree::
    :maxdepth: 2
 
+   how_to_run_a_scan
+   how_to_visualize_scan_results
+   how_to_extract_archives
+   how_to_format_scan_output
+   how_to_set_what_will_be_detected_in_a_scan
    add_new_license
    add_new_license_detection_rule
    install_new_license_plugin
+   run_as_library
    generate_attribution
+   how_to_add_a_post_scan_plugin
diff --git a/docs/source/how-to-guides/install_new_license_plugin.rst b/docs/source/how-to-guides/install_new_license_plugin.rst
@@ -1,7 +1,7 @@
 .. _install_external_licenses:
 
-How to Install External Licenses to Use in License Detection
-============================================================
+Install External Licenses to Use in License Detection
+=====================================================
 
 Users can install external licenses and rules in the form of:
 

diff --git a/docs/source/how-to-guides/run_as_library.rst b/docs/source/how-to-guides/run_as_library.rst
@@ -0,0 +1,39 @@
+.. _run_as_library:
+
+Run as Library
+==============
+
+If you’ve installed ScanCode-Toolkit as a library (:ref:`pip_install`), you
+can directly import it into your Python scripts.
+
+ScanCode-Toolkit offers a wide range of callable functions. Each function
+includes in-code documentation. Users can refer to it to understand the
+purpose of each function, then import and use the ones they need.
+
+While listing them all isn't feasible, here are a few sample use cases.
+
+To Run a Scan
+-------------
+
+::
+
+    from scancode.cli import run_scan
+
+
+See https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/scancode/cli.py#L535
+
+
+Get YAML Safe Text
+------------------
+
+::
+
+    from licensedcode.models import get_yaml_safe_text
+
+
+See https://github.com/aboutcode-org/scancode-toolkit/blob/develop/src/licensedcode/models.py#L777
+
+
+.. NOTE::
+
+    For more sample usages, refer https://github.com/nexB/scancode.io/blob/main/scanpipe/pipes/scancode.py
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -43,18 +43,6 @@ Reference documents describe the Command Line options, and application concepts
 
 ----
 
-Tutorials
----------
-
-Tutorial documents provide specific instructions to help you get started.
-
-.. toctree::
-   :maxdepth: 2
-
-   tutorials/index
-
-----
-
 How-To Documents
 ----------------
 

diff --git a/docs/source/rst_snippets/other_imp_doc.rst b/docs/source/rst_snippets/other_imp_doc.rst
@@ -3,7 +3,6 @@ Other Important Documentation
 
 #. :ref:`scancode_cli_options`
 #. :ref:`how_to_run_a_scan`
-#. :ref:`tutorials`
 #. :ref:`how_to_guides`
 #. :ref:`how_it_works`
 #. :ref:`contrib_code_dev`

diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst