Yellow-Dog-Man / Resonite-Issues

Issue repository for Resonite.
https://resonite.com
135 stars 2 forks source link

Help Screen on the Dashboard #1123

Open shiftyscales opened 8 months ago

shiftyscales commented 8 months ago

Is your feature request related to a problem? Please describe.

There are many useful Resonite-related resources, and websites that offer a variety of useful functionality that are not easily accessible in-app without prior knowledge of their existence, e.g. Support Moderation GitHub Wiki Policies Discord Twitch

Describe the solution you'd like

An additional tab/facet on the home screen with a links to all of the common resources, tutorials, knowledge bases, etc. that already exist in the community, but aren't easily able to be discovered organically.

The facet can be produced as an interface by the content team similar to other facet templates.

Some preliminary work has already gone into this issue. @RyuviTheViali has previously produced the following mockups of what such an interface/facet could look like.

277540790-4efa4ca5-d0c9-45df-9071-5f047f5937fc 277540799-de0f85e5-27f0-4248-9a63-484df93bcb48 277540810-a6a1cf67-e3c7-4766-bb5d-03bdb7fea587 277540817-bf9c65b6-9b8e-4ebe-9e30-489e7ef12522 277540820-a6b812cb-b1cf-44b2-a3f4-7801911578cd 277540827-f2c46f18-99a5-4d98-9440-66758e89f5c9

Describe alternatives you've considered

N/A

Additional Context

Creating this issue in place of an internal one that was previously created before this issue repo existed.

We should put a list of information we want to have displayed. Both short term and long term.

Here's some stuff to get started:

Controls diagram
Links to resources (moderation, support, GitHub, Wiki, Discord, Twitch...)
Searchable knowledge base
Searchable tutorials
Team credits
License information (for libraries and such)
JackTheFoxOtter commented 8 months ago

@shiftyscales it appears the images you've linked are broken, they aren't being displayed for me. I think you might have linked them from your internal repo where others don't have access to instead of re-uploading them here.

shiftyscales commented 8 months ago

Didn't think to check that. Can you see them now, @JackTheFoxOtter?

JackTheFoxOtter commented 8 months ago

Didn't think to check that. Can you see them now, @JackTheFoxOtter?

Affirmative! Thanks :)

TisFoolish commented 8 months ago

Instead of another tab along the bottom (which is already starting to get a bit crowded, and that's before you include any facet generated tabs a lot of users have), what about having a button in the home screen that brings up the info?

TisFoolish commented 8 months ago

Additionally, I can't see Help being a tab used all that much after a user gets used to Res. As a facet button they can just remove it from home if they ever feel like it no longer serves a purpose. This is not so with tabs (or at least not anywhere near as easily as you can with facets).

JackTheFoxOtter commented 8 months ago

Instead of another tab along the bottom (which is already starting to get a bit crowded, and that's before you include any facet generated tabs a lot of users have), what about having a button in the home screen that brings up the info?

I think this makes much sense as a dash tab. There will also be more in the future. The underlying problem here I think is that too many dash tabs might be getting a bit much to handle, but that would be a separate issue from this one. I've already suggested an option to hide the "migration" tab in https://github.com/Yellow-Dog-Man/Resonite-Issues/discussions/614, I don't see a reason why that wouldn't also be possible for the help tab. I've also had a new user once give me the feedback that some of the tabs on the dash could probably get simplified / merged, mainly the "inventory" and "files" tabs, which I think would make sense.

Frooxius commented 8 months ago

I think this would make most sense as a separate tab. This will make it easy to access for users and is generally important enough.

We'll want users to come to this section more often too in the future, for documentation and other things as it grows.

shiftyscales commented 7 months ago

Quick note: We should also include links to our Patreon, etc. here too. #520.

ProbablePrime commented 2 months ago

Now Ryuvi has access to the codebase, they can handle the code portions of this.

AmasterAmaster commented 1 month ago

@shiftyscales I would like to request adding the Mentor Program information to this help tab for this issue, as people have mentioned that they dont know what it is or how it works.

I am not sure if it is ok to ask for you to edit this, but I would appreciate it and I think it would help the community that much more.