Merge pull request #5 from MagicalCodeMonkey/how-tos

Add basic How-tos and update related documentation
This commit is contained in:
MagicalCodeMonkey
2020-03-31 18:50:50 -04:00
committed by GitHub
9 changed files with 37 additions and 3 deletions
@@ -1,7 +1,12 @@
# Documentation Guidelines
Almost all of the pages in this documentation are written in markdown and conform to the rules of markdownlint. If you contribute to the documentation, make sure that your edits pass linting which will automatically occur once you submit you changes.
Almost all of the pages in this documentation are written in markdown and conform to the [rules of markdownlint](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md). If you contribute to the documentation, make sure that your edits pass linting which will automatically occur once you submit you changes.
When creating documentation, please try to do the following:
- Follow logical groupings for sections and pages. E.g. - All documentation for How-tos is under `docs/how-tos/`
- Place images in the `docs/img/` following the same logical groupings as above. E.g. - All images for How-tos are under `docs/img/how-tos`
If you run into any linting issues, you may find a full list of linting rules, and examples, in the [markdownlint repository](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md)
+4 -2
View File
@@ -13,9 +13,11 @@ hide_nav_right: true
SyncLounge uses your Plex account to fetch details about your Plex Clients and Media Servers to use within the app. For security concerns, see the 'Security' section below.
- _Can I make someone else the 'host' of a room?_
- _How do I do X when using SyncLounge?_
Yes! Double-click their avatar to make them a host.
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.
If you are trying to figure out how to do something when *running* SyncLounge, check the [how-to](/how-tos/how-tos/) and [Self-hosting](/self-hosted/getting-started/) sections. This will tell you how to setup and configure your servers.
## Issues
+7
View File
@@ -0,0 +1,7 @@
## 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.
![Change Host GIF](/img/how-tos/change-host/ChangeHost.gif)
+4
View File
@@ -0,0 +1,4 @@
# How-tos
Use the navigation to the left to find how-tos of interest.
+12
View File
@@ -0,0 +1,12 @@
# Party Pausing
The host can enable or disable Party Pausing using the toggle in the upper-right 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.
![Party Pausing Guest Button](/img/how-tos/party-pausing/PartyPausing-GuestButton.png)
Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 649 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

+4
View File
@@ -54,6 +54,10 @@ nav:
- Docs Home: index.md
- FAQ:
- FAQ: faq.md
- How-tos:
- How-to Home: how-tos/how-tos.md
- Change the Host: how-tos/change-host.md
- Party Pausing: how-tos/party-pausing.md
- Self-Hosting:
- Getting Started: self-hosted/getting-started.md
- Running with Docker: self-hosted/docker.md