vinistock/sail

Add a quick reference guide to the dashboard

vinistock opened this issue · 0 comments

Context

Often, the people responsible for managing configurations in production like environments are not technical or do not engage directly with coding.

Therefore, it is unlikely that any non-technical admin will look for the gem's README or Wiki for support on its usage. Having a quick reference guide can make sure users will make the most out of Sail.

Request

Add a "Guide" link to the nav bar on the right that will display a modal containing a quick reference guide on how to use the dashboard. The guide should include all the following information in a concise and clear manner:

  • The list of all groups
  • The list of all cast types (not all available, but all the ones used in settings)
  • Information on what the labels mean
  • Information on how to use the search
  • Information on how to use profiles
  • Information on what the relevancy score is

Feedback

As always, feedback and thoughts on the new feature are much appreciated.