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: An Interactive Product Tour Guide for New Users #439

Open
nitin10s opened this issue Apr 14, 2020 · 6 comments
Open

Doc: An Interactive Product Tour Guide for New Users #439

nitin10s opened this issue Apr 14, 2020 · 6 comments

Comments

@nitin10s
Copy link

Description

Step-By-Step Guide or Product Tour of the features and application for the first time installers. [Something like https://introjs.com/], so new users could know:

  1. How to start using the application
  2. What are all the features and views that users can utilize
  3. Where are all the options located
@mjherzog
Copy link
Member

Our current focus is to upgrade the primary documentation at https://scancode-workbench.readthedocs.io/en/develop/#. The Getting Started section is intended to cover 1 and HowTo Guides is intended to cover 2 and 3.

@mjherzog mjherzog changed the title An Interactive Product Tour Guide for New Users Doc: An Interactive Product Tour Guide for New Users Apr 16, 2020
@nitin10s
Copy link
Author

No I mean an interactive tour that shows where all the features are located. Check the demo on https://introjs.com/. Something like that.

@mjherzog
Copy link
Member

@nitin1 We need to focus on improving the existing RTD documentation before adding an interactive tour which is much more complex to create and update.

@nitin10s
Copy link
Author

Oh ok.

@steven-esser
Copy link
Contributor

@nitin10s This may be a good idea sometime in the very far future. For now, there is too much work to be done on the initial doc side before we can think about something like this.

@OmkarPh
Copy link
Collaborator

OmkarPh commented Jul 19, 2023

The interactive tour guide still looks a bit far-fetched feature.
We can update the README & doc first, Later try adding a screen-recorded video

@OmkarPh OmkarPh closed this as completed Jul 19, 2023
@OmkarPh OmkarPh reopened this Jul 19, 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

4 participants