Page MenuHomeSoftware Heritage

Restructure the help web-app page
Closed, MigratedEdits Locked

Description

https://archive.softwareheritage.org/browse/help/#overview

This page should contain a link to the different guides and to the guided tour.
Also, when the guided tour is published, would this page disappear?
by clicking on help you enter the guided tour but you might want access to specific guides and FAQ.

Options possible:
A. end the guided tour on this page and propose the action "skip tour" on every step of the guide
B. add another icon specifically for the guided tour and keep ? for the help menu

In the help page we can add the following links:

  1. How to use the SWH API tutorial (https://docs.softwareheritage.org/devel/getting-started/api.html in new location)
  2. How to archive and reference code (https://www.softwareheritage.org/howto-archive-and-reference-your-code/)
  3. Contribute to the SWH mission (https://www.softwareheritage.org/community/developers/)
  4. FAQ (https://www.softwareheritage.org/faq/ when it is published)
  5. Deposit guides with HAL?
  6. HOW to cite with Biblatex? (video tutorial)

Event Timeline

This page should contain a link to the different guides and to the guided tour.
Also, when the guided tour is published, would this page disappear?
by clicking on help you enter the guided tour but you might want access to specific guides and FAQ.

I think it is better to add a new section in the homepage for adding the links to the guides, they will be more visible.
Regarding making the guided tour public, I think it is time to do it, just need the confirmation from @rdicosmo.
I think keeping the Help icon to launch is the right way to go.
For the old Help page, we could remove it as its content is quite poor and redundant with the official Sphinx documentation.