Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Confusion with the Help Sections #440

Closed
nitin10s opened this issue Apr 15, 2020 · 2 comments
Closed

Doc: Confusion with the Help Sections #440

nitin10s opened this issue Apr 15, 2020 · 2 comments

Comments

@nitin10s
Copy link

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,
@mjherzog mjherzog changed the title Confusion with the Help Sections Doc: Confusion with the Help Sections Apr 16, 2020
@steven-esser
Copy link
Contributor

@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.

@johnmhoran johnmhoran added the ui label Feb 17, 2022
@OmkarPh
Copy link
Collaborator

OmkarPh commented Dec 29, 2023

Closing, as it was addressed recently in #602

@OmkarPh OmkarPh closed this as completed Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants