Update Index page

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

docs/source/cli-reference/synopsis.rst

@@ -18,28 +18,30 @@ Toolkit Command Line Interface in the following sections:
 Installation
 ------------
 
-Scancode-Toolkit installation can be installed from ``pip``, the default Python Package Manager.
-However, there are more ways to perform an installation, and refer the following sections for
+Scancode-Toolkit installation can be done by downloading ScanCode as an application, which
+is recommended generally. For users familiar with ``pip``, ScanCode is also available and can be
+installed from ``pip``, the default Python Package Manager. Refer the following sections for
 detailed Instructions on the each of the Installation Methods.
 
+- :ref:`app_install`
 - :ref:`pip_install`
-- :ref:`latest_release_download_install`
-- :ref:`source_configure_install`
+- :ref:`source_code_install`
 
 .. _synopsis_quickstart:
 
 Quickstart
 ----------
 
-The basic command to perform a scan, if Scancode is installed from ``pip``::
+The basic command to perform a scan, in case of a download and configure installation
+(on Linux/MacOS) is::
 
-    scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
+    path/to/scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
 
-The basic usage in case of a download and configure installation (on Linux/MacOS) is::
+The basic usage, if Scancode is installed from ``pip``, or in Windows::
 
-    path/to/scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
+    scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
 
-.. include::  /rst_snippets/tip_snippets/synopsis_quickstart.rst
+.. include::  /rst_snippets/note_snippets/synopsis_install_quickstart.rst
 
 Here Scancode scans the <SCAN INPUT> file or directory for license, origin and packages and saves
 results to FILE(s) using one or more output format option. Error and progress are printed to
@@ -64,10 +66,12 @@ While a scan using absolute paths from the file system root will look like::
     home/ayansm/software/scancode-toolkit-3.1.1/scancode -clpieu --json-pp home/ayansm/scan_scan_results/output.json home/ayansm/codebases/samples/
 
 Commands similar to ``scancode --clpi --json-pp output.json samples`` will be used as examples
-throughout the documentation. Here we are inside the ``virtualenv`` where Scancode-Toolkit was
-installed by ``pip``, and the default ``samples`` folder is being scanned, which is distributed
-by default with Scancode-Toolkit.
+throughout the documentation.
+
+- Here we are inside the ``virtualenv`` where Scancode-Toolkit is configured.
 
+- And the default ``samples`` folder is being scanned, which is distributed by default with
+  Scancode-Toolkit.
 
 .. _scancode_cli_options:
 

docs/source/conf.py

@@ -34,7 +34,9 @@
 # This points to aboutcode.readthedocs.io
 # In case of "undefined label" ERRORS check docs on intersphinx to troubleshoot
 # Link was created at commit - https://github.com/nexB/aboutcode/commit/faea9fcf3248f8f198844fe34d43833224ac4a83
-intersphinx_mapping = {'aboutcode': ('https://aboutcode.readthedocs.io/en/latest/', None)}
+
+intersphinx_mapping = {'aboutcode': ('https://aboutcode.readthedocs.io/en/latest/', None),
+                       'scancode-workbench': ('https://scancode-workbench.readthedocs.io/en/develop/', None)}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/source/index.rst

@@ -1,21 +1,23 @@
 ScanCode Toolkit Documentation
 ==============================
 
-Guide
------
+Welcome to ScanCode Toolkit Documentation!
+
+If you are new to ScanCode Toolkit, start here:
 
 .. toctree::
    :maxdepth: 2
 
-   getting-started/index
-   cli-reference/index
-   plugins/index
-   tutorials/index
-   how-to-guides/index
-   explanations/index
-   contribute/index
-   misc/index
-   license
+   getting-started/newcomer
+
+Here's a list of more Documentation Pages:
+
+- A :ref:`cli_synopsis` of ScanCode Command Line Options
+- Tutorials on :ref:`how_to_run_a_scan` and :ref:`how_to_visualize_scan_results`
+- An exhaustive List of :ref:`cli_list_options`
+- Documentation on :ref:`contrib_code_dev`
+- Documentation on :ref:`plugin_arch`
+- :ref:`faq`
 
 ----
 
@@ -25,12 +27,24 @@ Getting Started
 .. toctree::
    :maxdepth: 2
 
-   getting-started/newcomer
+   getting-started/index
 
 ----
 
-Tutorial Documents
-------------------
+Command Line Options Reference
+------------------------------
+
+Reference documents describe the Command Line options, and application concepts in depth.
+
+.. toctree::
+   :maxdepth: 2
+
+   cli-reference/index
+
+----
+
+Tutorials
+---------
 
 Tutorial documents provide specific instructions to help you get started.
 
@@ -53,18 +67,36 @@ How-To documents explain how to accomplish specific tasks.
 
 ----
 
-Reference Documents
--------------------
+Contribute To ScanCode
+----------------------
 
-Reference documents describe the Command Line options, and application concepts in depth.
+.. toctree::
+   :maxdepth: 2
+
+   contribute/index
+
+----
+
+Plugins Documentation
+---------------------
 
 .. toctree::
    :maxdepth: 2
 
-   cli-reference/index
+   plugins/index
 
 ----
 
+Miscellaneous Documents
+-----------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   misc/index
+   license
+
+
 Discussion Documents
 --------------------
 

docs/source/rst_snippets/note_snippets/synopsis_install_quickstart.rst

@@ -1,4 +1,15 @@
 .. note::
 
-    For more information on the Scan Command for Various Installation Methods/Operating Systems,
-    refer :ref:`syn_install`.
+    Please note that different for different install methods, scan commands vary.
+
+    The basic command to perform a scan, in case of a download and configure installation
+    (on Linux/MacOS) is::
+
+        path/to/scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
+
+    The basic usage, if Scancode is installed from ``pip``, or in Windows::
+
+        scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
+
+    For more information on how the Scan Command varies for Various Installation
+    Methods/Operating Systems, refer :ref:`commands_variation`.