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

Update: Help documentation on website #1411

Open
tylersnel opened this issue May 24, 2024 · 2 comments
Open

Update: Help documentation on website #1411

tylersnel opened this issue May 24, 2024 · 2 comments
Labels
ACK_WAITING Issue waiting acknowledgement from core team before to start the work to fix it. HELP_WANTED Issue for which help is wanted to do the job. UPDATE_CS Issue about the update/refactoring of a existing cheat sheet.

Comments

@tylersnel
Copy link

What is missing or needs to be updated?

Currently, there doesn’t seem to be help documentation available to users of the cheat sheets when they run into issues or if they have basic questions.

How should this be resolved?

Maybe a basic help document that covers cheat sheet navigation, FAQs, a troubleshooting guide, links to feedback and support, and step-by-step guides on how to use basic features available in the cheat sheets might be useful to some users.

@tylersnel tylersnel added ACK_WAITING Issue waiting acknowledgement from core team before to start the work to fix it. HELP_WANTED Issue for which help is wanted to do the job. UPDATE_CS Issue about the update/refactoring of a existing cheat sheet. labels May 24, 2024
@szh
Copy link
Collaborator

szh commented May 24, 2024

I'm not opposed to the idea.

@jmanico
Copy link
Member

jmanico commented May 27, 2024

Same here -

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ACK_WAITING Issue waiting acknowledgement from core team before to start the work to fix it. HELP_WANTED Issue for which help is wanted to do the job. UPDATE_CS Issue about the update/refactoring of a existing cheat sheet.
Projects
None yet
Development

No branches or pull requests

3 participants