Update documentation (#17)

* Update FAQ * Update App How-tos & assets * Rename Report an Issue file to proper naming * Re-order How-tos menu * Linting
2020-04-20 23:36:19 -04:00
parent 3828301fce
commit 341e3b25ab
13 changed files with 52 additions and 24 deletions
@@ -17,6 +17,28 @@ hide_nav_right: true

    You don't have to share your Plex server if they have access to the same media on their own or another Plex server. If they don't have access to a Plex server with the same media, you will need to share your Plex server with them.

+- _What clients are supported?_
+
+    SyncLounge tries to maintain support as many clients as possible. However, changes to implementation on Plex's or the client's side can cause them to no longer work properly. Below are the supported clients and some known issues and solutions, where possible. If a solution doesn't work, an update probably broke its compatibility.
+
+      - If the site is running using SSL (HTTPS), due to the way some of the Plex clients have been made they can only operate using HTTP. If the site allows for HTTP use, like the [hosted Synclounge does](http://app.synclounge.tv/) then try that to see if it will work.
+      - **Plex Media Player**: The original [Plex Media Player](https://forums.plex.tv/t/plex-media-player/120475/100) for Windows and MacOS is, as of writing this, still supported. Follow the link and scroll down to the newest to download.
+      - **Plex Desktop app**: You may encounter issues using this. Try the original Plex Media Player application above for better results.
+      - **New Plex Player**: If you are using the new Plex Player, Plex changed the way it operates. Try changing back to the "old player" and see if it works.
+      - **Android based players (Roku, Android TV, Fire TV, etc.)**: These players can't remote start media properly. Some have had success starting the media and pausing it, then having the host start the media.
+      - **AppleTV**: Plex must be open before trying to connect.
+      - **Plex Home Theater**
+      - **OpenPHT**
+      - **Rasplex**
+      - **iOS (iPhone & iPad)**
+
+    Unsupported or Broken:
+
+      - **Smart TVs**
+      - **Plex Web Player (Chrome/Safari/Firefox)**
+      - **Xbox**
+      - **Playstation**
+
 - _How do I do X when using SyncLounge?_

    If you are trying to figure out how to do something when *using* SyncLounge, check the [how-to](/how-tos/how-tos/) section of the documentation. This will show you how to change hosts, user Party Pausing, etc.
@@ -27,7 +49,11 @@ hide_nav_right: true

 - _I can't log in to SyncLounge_

-    This is most likely due to Popup Blocking. If you press the "Click me" button and nothing happens, make sure that your browser isn't blocking popups for the site.
+    This is most likely due to Popup Blocking or an Adblocker. If you press the "Click me" button and nothing happens, make sure that your browser isn't blocking popups for the site. If you get a new window with the Plex logo, but nothing else happens, make sure that you don't have an AdBlocker or other plugin that is interfering with Plex completing the OAuth request.
+
+- _My client isn't working!_
+
+    See _What clients are supported?_ for information.

 - _When trying to connect to my server, "Unable to connect" "Try disabling your adblocker" appears even though there is no adblocker or it has been disabled._

@@ -37,28 +63,21 @@ hide_nav_right: true
      - The server owner's firewall, network configuration, ISP, or some other software is blocking the connection.
      - Remote access is not enabled on the server or it isn't working properly. To enable remote access or to check if remote access is enabled succesfully, see the [Plex's Remote Access article](https://support.plex.tv/articles/200289506-remote-access/)

- _Client X isn't working!_
-
-    SyncLounge tries to maintain support as many clients as possible. However, changes to implementation on Plex's or the client's side can cause them to no longer work properly. Here are some known issues and solutions, where possible:
-
-      - If the site is running using SSL (HTTPS), due to the way some of the Plex clients have been made they can only operate using HTTP. If the site allows for HTTP use, like the [hosted Synclounge does](http://app.synclounge.tv/) then try that to see if it will work.
-      - **Plex Desktop app**: You may encounter issues using this. Try the original [Plex Media Player application](https://forums.plex.tv/t/plex-media-player/120475/100) for Windows and MacOS. Scroll down to the newest to download.
-      - **New Plex Player**: If you are using the new Plex Player, Plex changed the way it operates. Try changing back to the "old player" and see if it works.
-      - **Android based players**: These players can't remote start media properly.
-      - **AppleTV**: Make sure that it is open before trying to connect.
-      - **SmartTV**: Plex apps on SmartTVs don't work.
-
 - _Someone in my room is getting "the quota has been exceeded"_
 - _The SyncLounge player is continually buffering_
 - _I'm getting the message `Failed to execute 'appendBuffer' on 'SourceBuffer': The SourceBuffer is full, and cannot free space to append additional buffers.`

-    Lower the bitrate (aka streaming quality) on the client.
+    Lower the bitrate (aka streaming quality) on the client. If you are using the SyncLounge Player, you can do this by clicking the settings cog in the upper-right of the player.
+
+- _The media could not be loaded, either because the server or network failed or because the format is not supported_
+
+    Turn off force transcode by going to the menu in the top left > synclounge settings > force transcode

 - _Someone in my room is getting "Failed to find a compatible copy of `<MEDIA_NAME>`. If you have access to the content try manually playing it."_

    SyncLounge is unable to retrieve information for the currently selected media on the server the user has access to. This is usually caused by the user not having access to the media that the host is playing. See _Do the other users in my room need access to my Plex Server?_ for more information.

-If any of the above don't answer your question or address your issue, see the How-to: [Report an Issue](/how-tos/report_an_issue/) page.
+If any of the above don't answer your question or address your issue, see the How-to: [Report an Issue](/how-tos/report-an-issue/) page.

 ## Security

@@ -1,7 +1,14 @@

 ## Change the host of a room

-The host controls what video is watched and if it is playing or paused.
-To make another user the host, double-click their avatar. This can only be done if you are the host. If you accidentally make someone the host, you'll have ask them to set you to be host again.
+The host controls what video is watched and if it is playing or paused. If you accidentally make someone the host, you'll have ask them to set you to be host again.

-![Change Host GIF](/img/how-tos/change-host/ChangeHost.gif)
+To make another user the host, you can do either of the following:
+
+- Double-click the user's avatar
+
+    ![Change Host by Avatar GIF](/img/how-tos/change-host/ChangeHostAvatar.gif)
+
+- Use the menu to the right of their name
+
+    ![Change Host by Menu GIF](/img/how-tos/change-host/ChangeHostMenu.gif)
@@ -1,12 +1,12 @@

 # Party Pausing

-The host can enable or disable Party Pausing using the toggle in the upper-right of the User list.
+The host can enable or disable Party Pausing using the toggle at the top of the User list.

 ![Party Pausing Host Toggle](/img/how-tos/party-pausing/PartyPausing-HostToggle.png)

 Regardless of if party pausing is enabled, the host can always pause or play a video using the button on the player (bottom-left).

-If Party Pausing is enabled, the guests will see the play/pause button in the upper-right of the User list. This button will allow them to pause/play the video for everyone in the room.
+If Party Pausing is enabled, the guests will see the play/pause button at the top of the User list. This button will allow them to pause/play the video for everyone in the room.

-![Party Pausing Guest Button](/img/how-tos/party-pausing/PartyPausing-GuestButton.png)
+![Party Pausing Guest Play Button](/img/how-tos/party-pausing/PartyPausing-GuestPlayButton.png) ![Party Pausing Guest Pause Button](/img/how-tos/party-pausing/PartyPausing-GuestPauseButton.png)
@@ -10,7 +10,9 @@ If not:

 It is preferred that issues are reported on the [Issue Tracker](https://github.com/samcm/synclounge/issues) and then raise it on [Discord](https://discord.gg/fKQB3yt).

-When reporting an issues, please try to be as detailed as possible. If you aren't going to report the issue on the [Issue Tracker](https://github.com/samcm/synclounge/issues), copy/paste and complete the following in Discord:
+When reporting an issues, please try to be as detailed as possible. If needed, you can generate logs from your client device (player). Information can be found in the troubleshooting section of the How-tos.
+
+If you aren't going to report the issue on the [Issue Tracker](https://github.com/samcm/synclounge/issues), copy/paste and complete the following into the Issues channel in Discord:

 ```markdown
 **Web App**
@@ -16,7 +16,7 @@ All of the variables and what they do can be found on the [Settings](/self-hoste

 ## Issues

-If you encounter any issues setting up SyncLounge, see the [Report an Issue](/how-tos/report_an_issue/) page.
+If you encounter any issues setting up SyncLounge, see the [Report an Issue](/how-tos/report-an-issue/) page.

 ## Running

@@ -56,11 +56,11 @@ nav:
      - FAQ: faq.md
  - How-tos:
      - How-to Home: how-tos/how-tos.md
+      - Report an Issue: how-tos/report-an-issue.md
+      - Self-hosting: self-hosted/getting-started.md
      - Using the App:
          - Change the Host: how-tos/app/change-host.md
          - Party Pausing: how-tos/app/party-pausing.md
-      - Self-hosting: self-hosted/getting-started.md
-      - Report an Issue: how-tos/report_an_issue.md
  - Self-Hosting:
      - Getting Started: self-hosted/getting-started.md
      - Running with Docker: self-hosted/docker.md