Merge pull request #646 from aboutcode-org/update-README

Update README.md

Author: AyanSinhaMahapatra

.github/workflows/Release.yml

@@ -12,18 +12,19 @@ jobs:
     name: Create Release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
       # - name: Exit if tag not is not pointing to a commit in master branch
       #   if: endsWith(github.ref, 'master') == false
       #   run: exit -1
       - name: Get release tag
         id: tag
-        uses: dawidd6/action-get-tag@v1
+        # TODO: replace this as this is archived now? 
+        uses: dawidd6/action-get-tag@727a6f0a561be04e09013531e73a3983a65e3479
         with:
           strip_v: false
       - name: Create Release
         id: create_release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda
         with:
           tag_name: ${{steps.tag.outputs.tag}}
           name: ${{steps.tag.outputs.tag}}
@@ -41,13 +42,13 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest, macos-14]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
         with:
-          python-version: 3.12.0
-      - uses: actions/setup-node@master
+          python-version: 3.14.0
+      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020
         with:
-          node-version: 20
+          node-version: 22
       - name: Install dependencies
         run: npm install
       - name: Create release assets directory
@@ -59,7 +60,7 @@ jobs:
       - name: Verify Generated archives in dist/
         run: ls ./dist
       - name: Upload release assets
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda
         with:
           tag_name: ${{ github.ref_name }}
           files: dist/*

.github/workflows/Test.yml

@@ -11,13 +11,13 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [22.x, 24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@master
+        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

.github/workflows/docs-ci.yml

@@ -7,19 +7,19 @@ permissions:
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.12.0]
+        python-version: [3.14.0]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
         with:
           python-version: ${{ matrix.python-version }}
 

.husky/pre-commit

@@ -2,4 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm test
-cd docs && ./scripts/doc8_style_check.sh && ./scripts/sphinx_build_link_check.sh
+#cd docs && ./scripts/doc8_style_check.sh && ./scripts/sphinx_build_link_check.sh

README.md

@@ -4,19 +4,32 @@
 [![Test CI](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml/badge.svg)](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml)
 [![Release](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Release.yml/badge.svg)](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Release.yml)
 
-ScanCode Workbench provides an advanced visual UI to help you quickly evaluate
-license and other notices identified by
-[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/).
-[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/) detects licenses,
-copyrights and other interesting information in your code.
-
-ScanCode Workbench is based on [Electron](https://www.electronjs.org/) and will
-be the primary desktop/GUI tool for using nexB’s
-[AboutCode tools](https://github.com/nexB/aboutcode). This app works on Windows,
-macOS and Linux operating systems.
+ScanCode Workbench provides a visual UI (GUI) to help you quickly evaluate
+license, copyright and other important information from a
+[ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit/) scan.
+
+The Workbench is a single-user desktop application that works on Windows,
+macOS, and Linux operating systems. There is no current or planned future 
+functionality to edit or update scan results - the scan data is read-only.
+
+If you need a multi-user application for running or reviewing ScanCode scans,
+you should use [ScanCode.io](https://github.com/aboutcode-org/scancode.io) 
+instead of ScanCode Workbench. You cannot edit scan data in ScanCode.io, but 
+you can export the scan data in SBOM, XLSX and other formats for further 
+analysis and processing. You can also import a ScanCode Toolkit scan into
+ScanCode.io using the `load_inventory` pipeline.
+
+If you need an application to review and edit ScanCode scan data or to convert
+that data into an SBOM or a software inventory, you should use [DejaCode](https://github.com/aboutcode-org/dejacode). You can import scan data from ScanCode Toolkit or ScanCode.io into DejaCode or you can import an SBOM. The DejaCode
+Dashboard provides immediate visibility into license or vulnerability issues
+related to your products, components and packages. You can use the [DejaCode demo system](https://public.dejacode.com/account/register/) for quick access to its
+features and functions.
 
 ![ScanCode Workbench](/src/assets/images/workbench_intro.gif)
 
+ScanCode Workbench is based on [Electron](https://www.electronjs.org/).
+
+
 ## Using
 
 - You can
@@ -28,7 +41,7 @@ macOS and Linux operating systems.
   [ScanCode v32.0.0](https://github.com/aboutcode-org/scancode-toolkit/releases)
   and above which are run with the ScanCode `-i` option. For a list of available
   ScanCode options see
-  [How To: Set 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)
+  [How To: Set what will be detected in a scan](https://scancode-toolkit.readthedocs.io/en/latest/tutorials/configuring-scan-detection.html)
 
 ```bash
 scancode -clipeu <input> <output_file>

docs/source/getting-started/index.rst

@@ -45,8 +45,8 @@ ScanCode Workbench-ScanCode Toolkit Compatibility
 .. 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
+   :doc:`scancode-toolkit:tutorials/configuring-scan-detection`.
+   Also see :doc:`scancode-toolkit:tutorials/running-a-scan` for more details
    on running a ScanCode Toolkit scan.
 
 Open ScanCode Workbench and Load a ScanCode Toolkit Scan

docs/source/ui-reference/license-explorer.rst

@@ -8,7 +8,7 @@ Details of all the License detections and clues including Matches as well as fil
 were detected can be viewed using the License Explorer.
 
 Refer -
-:doc:`scancode-toolkit:reference/license-detection-reference`
+:doc:`scancode-toolkit:explanation/scancode-license-detection`
 
 License Navigation Pane
 -------------------------------

docs/source/ui-reference/package-explorer.rst

@@ -9,7 +9,7 @@
 Details of all the Packages & dependencies as well as files in which
 they were detected can be viewed using the Package Explorer.
 
-Refer - :doc:`scancode-toolkit:reference/available_package_parsers`.
+Refer - :doc:`scancode-toolkit:reference/scancode-supported-packages`.
 
 Package Navigation Pane
 --------------------------------

docs/source/ui-reference/scan-info.rst

@@ -13,7 +13,7 @@ Fields:
 - ``Tool`` - Name of the tool which generated this scan
 - ``Tool version`` - Version of the tool which generated this scan
 - ``Input`` - Input path on which scan was run
-- ``Scan Options`` - :doc:`scancode-toolkit:cli-reference/basic-options`.
+- ``Scan Options`` - :doc:`scancode-toolkit:reference/scancode-cli/cli-basic-options`.
 - ``Files count`` - Total number of files scanned
 - ``Output format version`` - Used to track compatibility with current workbench application
 - ``SPDX license list version`` - Version of SPDX license list used

docs/source/ui-reference/table-view.rst

@@ -16,7 +16,7 @@ is also available in this view.
 
 .. Note::
   The data in tableview is only available if corresponding options were enabled when performing the scan.
-  Refer - :doc:`scancode-toolkit:cli-reference/list-options`.
+  Refer - :doc:`scancode-toolkit:reference/scancode-cli/cli-basic-options`.
 
 ----------------
 Column groups