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

FAQ Page #1316

Closed
karyogamy opened this issue Apr 14, 2018 · 10 comments
Closed

FAQ Page #1316

karyogamy opened this issue Apr 14, 2018 · 10 comments
Labels
meta Related to the project but not strictly to code

Comments

@karyogamy
Copy link
Contributor

Currently, our users have to either rely on word of the mouth on forums or github to troubleshoot common problems and discover new features, such as swipe to close popup window. IIRC, it was suggested that we should introduce a tutorial fragment to guide new users when they first open the app. However, because the rollout period for newpipe is quite long, updates to the tutorial and troubleshooting information will be delayed for a long time as well. Not to mention the additional cost of developing a dedicated fragment/activity in the app to support tutorials.

So, I propose we create some dedicated pages on the website which:

  1. guides new users through the important features
  2. shows the new features and/or a condensed release notes of important updates on each version rollout
  3. FAQs for common questions we can redirect to, which we can use as an additional check on github before creating issues.

With those pages, we can simply add some obvious buttons in the app which opens them up, and can be easily updated in realtime, in case of emergency updates or announcements.

@TobiGr
Copy link
Contributor

TobiGr commented Apr 14, 2018

That was the idea behind #859.

  1. guides new users through the important features

I have a working proof of concept for this. The only thing that's a bit complicated is that the release information is written markdown while we'd require some kind of HTML or separated information. I already asked @theScrabi to create changelogs in the fastlane folder. We should extract every information needed via the web-api and then fetch that JSON. I tried to display release information via a webview too, but unfortunately webviews need quite long for the first initialization.

Unfortunately I spend most of my spare time to keep the website up-to-date so I hadn't time to bring this in a good state.

  1. shows the new features and/or a condensed release notes of important updates on each version rollout

We could do this via a blog post and link it in the "What's New" dialog. This would keep the app small.

  1. FAQs for common questions we can redirect to, which we can use as an additional check on github before creating issues.

We get a bunch of same questions on the blog so I already thought about a FAQ page for https://newpipe.schabi.org. I wanted to include at least the following information

  • open stream options with a longpress on the stream item in a list

  • longpress on background / popup buttons to enqueue stream

  • import / export subscriptions

  • import / export app data (history, ...)

  • swipe to left/right to close popup player

Is there anything to add?


Offtopic: we should move the about activity to the settings and then add information about tutorials there.

@karyogamy
Copy link
Contributor Author

karyogamy commented Apr 14, 2018

For the tutorial, can we have host a listing of topics and screenshots like FAQs on the website and create a dialog in the app on first startup? This would probably be easier implement and should suffice our needs until a prettier version is available.

Or maybe we can merge FAQ and tutorial together for now and separate them later once #859 is fully implemented.

Some more FAQs:

  • how to open up the background player queue from notification (though this should be part of the tutorial)
  • downloading on sdcard is not functional and is in the works right now
  • what's new / feed is currently experimental and is in the works right now
  • age-gated video will produce an error snackbar on video details fragment
  • auto-play toggle
  • how to switch between players
  • how to search and play SoundCloud streams

Generally anything that gets asked multiple times in issues can be added to FAQs.

@JuniorJPDJ
Copy link

Some use instructions about popup also..
I had to look for resizing of popup on youtube...

@TobiGr
Copy link
Contributor

TobiGr commented Apr 14, 2018

For the tutorial, can we have host a listing of topics and screenshots like FAQs on the website and create a dialog in the app on first startup? This would probably be easier implement and should suffice our needs until a prettier version is available.

That is what i thought of.

If you want to implement the app part, I can give you what I already implemented. I could then take care of the website part.

@karyogamy
Copy link
Contributor Author

Oh, my bad. I meant a very simple dialog like "Would you like to go over the tutorial?" which opens up the page on an external browser, rather than having to implement a webview. Unless of course this is what you meant as well.

@TobiGr
Copy link
Contributor

TobiGr commented Apr 15, 2018

I meant a very simple dialog like "Would you like to go over the tutorial?" which opens up the page on an external browser, rather than having to implement a webview.

That sounds good. I'll take a closer look on how to organize the FAQ then.

@stale
Copy link

stale bot commented Dec 1, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Dec 1, 2018
@TobiGr TobiGr removed the stale label Jul 19, 2019
@Stypox Stypox added the meta Related to the project but not strictly to code label Jul 21, 2019
@opusforlife2
Copy link
Collaborator

Close, since we have a FAQ now?

Do we want the FAQ duplicated on Github's wiki?

@Stypox
Copy link
Member

Stypox commented Oct 8, 2020

@opusforlife2 I don't think so, it would be a burden to maintain both. Instead a link to the FAQ should be added, if it does not exist already.

@Stypox Stypox closed this as completed Oct 8, 2020
@opusforlife2
Copy link
Collaborator

Added a link to the FAQ on the Home page of the wiki. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Related to the project but not strictly to code
Projects
None yet
Development

No branches or pull requests

5 participants