scancode-workbench icon indicating copy to clipboard operation
scancode-workbench copied to clipboard

Doc: Confusion with the Help Sections

Open nitin10s opened this issue 5 years ago • 1 comments

Description

Currently, the ways to access documentation and Help are:

  1. On the left menu bar
  2. On the top main menu

This can be unnecessarily confusing and should be merged into one.

Also, there are some discrepancies like:

  1. In Basics: The Link "ScanCode Workbench" opens Views, "Building" and "Platform Support" are not so important for users and could be included in the wiki itself and not presented in the application exclusively. We can discuss on this.
  2. [On Welcome Page] The "How to run a scan with ScanCode Toolkit" button redirects to https://github.com/nexB/scancode-toolkit/wiki/How-To:-Run-a-scan, which basically mentions 3 different links of Documentation. Rather the button should directly link to https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html,

nitin10s avatar Apr 15 '20 15:04 nitin10s

@nitin10s I think we are pretty open to suggestions here. I think at the very least we should have a link to the docs from the welcome page.

steven-esser avatar Apr 17 '20 20:04 steven-esser

Closing, as it was addressed recently in #602

OmkarPh avatar Dec 29 '23 05:12 OmkarPh