Add minor doc updates

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
aboutcode-org · Oct 18, 2023 · e7914f4 · e7914f4
1 parent 7e00d58
commit e7914f4
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 79 deletions.
diff --git a/docs/source/contribute/building.rst b/docs/source/contribute/building.rst
@@ -32,25 +32,8 @@ Linux
 - Python 3.7 or later
 - `Node.js <https://nodejs.org/en/download/package-manager/>`__ 12.x or later
 - npm 6.14.x or later
-- For CentOS (or linux distros without the new libstdc++) -
 
-   -  Install the new libstdc++ library:
-
-      .. code-block:: bash
-
-         yum provides libstdc++
-
-   -  Update LD_LIBRARY_PATH:
-
-      .. code-block:: bash
-
-         export LD_LIBRARY_PATH="/usr/local/lib64/:$LD_LIBRARY_PATH"
-
-   -  Run the application with ``no-sandbox`` option:
-
-      .. code-block:: bash
-
-         ./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox
+.. include:: ../rst_snippets/centos-note.rst
 
 MacOS
 -----

diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst
@@ -16,26 +16,7 @@ Download and Install
 
    On Windows 10, for example, the executable will be named `ScanCode-Workbench.exe`.
 
-.. Note::
-   For CentOS (or linux distros without the new libstdc++), follow these steps:
-
-   -  Install the new libstdc++ library:
-
-      .. code-block:: bash
-
-         yum provides libstdc++
-
-   -  Update LD_LIBRARY_PATH:
-
-      .. code-block:: bash
-
-         export LD_LIBRARY_PATH="/usr/local/lib64/:$LD_LIBRARY_PATH"
-
-   -  Run the application with ``no-sandbox`` option:
-
-      .. code-block:: bash
-
-         ./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox
+.. include:: ../rst_snippets/centos-note.rst
 
 -  If you're interested in digging into the code, you can also use ScanCode Workbench by cloning
    the GitHub repository and building it yourself -- see the :ref:`Contribute/Building<building>`
@@ -44,15 +25,19 @@ Download and Install
 ScanCode Workbench-ScanCode Toolkit Compatibility
 =================================================
 
--  ScanCode Workbench >= v4.0.0 is only compatible with scans from ScanCode v32.x and above
-   that have been run with the ScanCode Toolkit ``-i`` option.
+-  ScanCode Workbench v4.x is only compatible with scans from ScanCode v32.x and above
+   that have been run with ScanCode Toolkit.
+
+- You would typically create your scan with the following command::
 
-   -  A list of available ScanCode Toolkit options is available in the ScanCode Toolkit
-      documentation:
-      :doc:`scancode-toolkit:tutorials/how_to_set_what_will_be_detected_in_a_scan`.
+   scancode -clipeu <input> --json-pp <output_file>
 
-- You would typically create your scan with the following command:
-  ``./scancode -clipeu <input> <output_file>``
+.. Note::
+   A list of available ScanCode Toolkit options is available in the ScanCode Toolkit
+   documentation:
+   :doc:`scancode-toolkit:tutorials/how_to_set_what_will_be_detected_in_a_scan`.
+   Also see :doc:`scancode-toolkit:tutorials/how_to_run_a_scan` for more details
+   on running a ScanCode Toolkit scan.
 
 Open ScanCode Workbench and Load a ScanCode Toolkit Scan
 ========================================================

diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
@@ -4,13 +4,6 @@
 :index:`How-To Guides`
 ======================
 
-The ScanCode Workbench How-To Guides will walk you through loading and analyzing
-a ``-clipeu`` scan of ``e2fsprogs-1.45.6.tar.gz``.
-
-.. Note:: If you'd like to follow along, you can download a copy of the ``e2fsprogs-1.45.6``
-   package from `SourceForge <https://sourceforge.net/projects/e2fsprogs/files/e2fsprogs/v1.45.6/>`__,
-   run a ``-clipeu`` scan with `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`__,
-   load the ``.json`` output into ScanCode Workbench and work your way through the How-To Guides.
 
 .. toctree::
    :maxdepth: 3

diff --git a/docs/source/how-to-guides/troubleshooting/check-for-errors.rst b/docs/source/how-to-guides/troubleshooting/check-for-errors.rst
@@ -9,8 +9,9 @@ provides details about the error and allows you to create an issue.
     :scale: 50 %
 
 If you can reproduce the error, use this approach to get the stack trace and report the issue. Open
-the Developer Tools with ``Ctrl+Shift+I`` or ``Alt+Cmd+I``. From there, click the Console tab.
-Include the error that is logged in the issue in a code block or a file attachment.
+the Developer Tools by clicking ```View`` -> ``Toggle Developer Tools``. From there, click the
+``Console`` tab. Include the error that is logged in the issue in a code block or a
+file attachment.
 
 You can `Create an issue here <https://github.com/nexB/scancode-workbench/issues>`__.
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,7 +12,6 @@ Welcome to the documentation for ScanCode Workbench!
    getting-started/index
    how-to-guides/index
    ui-reference/index
-   technical-reference/index
    contribute/index
    license
 

diff --git a/docs/source/overview/index.rst b/docs/source/overview/index.rst
@@ -26,14 +26,24 @@ This documentation is organized in six sections:
 
 -  The :ref:`ui-reference` section provides an overview of each of ScanCode Workbench's data views.
 
--  The :ref:`technical-reference` section summarizes ScanCode Workbench's underlying technology
-   and platform support.
-
 -  The :ref:`contribute` section is intended for advanced users and contributors to ScanCode
    Workbench development.
 
 -  The :ref:`license` section provides summary licensing information for ScanCode Workbench.
 
+Underlying Technology
+=====================
+
+-  ScanCode Workbench is based on `Electron <https://www.electronjs.org/>`__ and works on
+   Windows, OS X and Linux operating systems.
+
+Platform Support
+================
+
+* Linux - ``x64``
+* Windows 10/11 - ``x64``
+* MacOS - ``x64``, ``arm64``
+
 Important Links
 ===============
 

diff --git a/docs/source/rst_snippets/centos-note.rst b/docs/source/rst_snippets/centos-note.rst
@@ -0,0 +1,20 @@
+.. Note::
+   For CentOS (or linux distros without the new libstdc++), follow these steps:
+
+   -  Install the new libstdc++ library:
+
+      .. code-block:: bash
+
+         yum provides libstdc++
+
+   -  Update LD_LIBRARY_PATH:
+
+      .. code-block:: bash
+
+         export LD_LIBRARY_PATH="/usr/local/lib64/:$LD_LIBRARY_PATH"
+
+   -  Run the application with ``no-sandbox`` option:
+
+      .. code-block:: bash
+
+         ./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox
diff --git a/docs/source/technical-reference/index.rst b/docs/source/technical-reference/index.rst
diff --git a/docs/source/ui-reference/directory-tree.rst b/docs/source/ui-reference/directory-tree.rst
@@ -2,7 +2,7 @@
 :index:`Directory Tree`
 =======================
 
-An interactive Directory tree is present on the left side of the application for resource-focused
+An interactive directory tree is present on the left side of the application for resource-focused
 views. This allows the user to navigate the codebase structure.
 
 If a directory is selected, only the information for that directory and its sub-files and folders

diff --git a/docs/source/ui-reference/license-explorer.rst b/docs/source/ui-reference/license-explorer.rst
@@ -10,7 +10,7 @@ were detected can be viewed using the License Explorer.
 Refer -
 :doc:`scancode-toolkit:reference/license-detection-reference`
 
-.. @TODO - Replace with anchored link after merging docs PR in scancode-toolkit
+.. @TODO - Replace with anchored link after merging docs PR inScanCode Toolkit
 .. :doc:`scancode-toolkit:reference/license-detection-reference#what-is-a-licensedetection`
 
 License Navigation Pane
@@ -43,7 +43,7 @@ User can view the match details resulting the selected license :
 - ``Matched Text``
     | User can click on the text to view a diff of Matched & Rule text
     | (Requires ``--license-references`` flag)
-- ``Rule`` - User can click on the Rule to open the rule used by scancode-toolkit in browser
+- ``Rule`` - User can click on the Rule to open the rule used byScanCode Toolkit in browser
 - ``SPDX License expression``
 
 File Regions Table: