Merge pull request #441 from LizardByte/update/docs

update docs

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -6,7 +6,22 @@ body:
     attributes:
       value: >
         **THIS IS NOT THE PLACE TO ASK FOR SUPPORT!**
-        Please use [Discord](https://docs.lizardbyte.dev/en/latest/about/support.html#discord) for support issues.
+        Please use our [Support Center](https://app.lizardbyte.dev/support) for support issues.
+        Non actionable bug reports will be locked and closed!
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Is your issue described in the documentation?
+      description: Please read our [documentation](https://docs.lizardbyte.dev/projects/sunshine)
+      options:
+        - label: I have read the documentation
+          required: true
   - type: textarea
     id: description
     attributes:
@@ -30,10 +45,11 @@ body:
       label: Host Operating System
       description: What version operating system are you running the software on?
       options:
+        - Docker
         - Linux
         - macOS
         - Windows
-        - other
+        - other, n/a
   - type: input
     id: os-version
     attributes:
@@ -41,28 +57,50 @@ body:
       description: Provide the version of the operating system. Additionally a build number would be helpful.
     validations:
       required: true
-  - type: input
+  - type: dropdown
     id: os-architecture
     attributes:
       label: Architecture
-      placeholder: e.g. 32 bit, 64 bit, arm
+      options:
-    validations:
+        - 32 bit
-      required: true
+        - 64 bit
+        - arm
+        - other, n/a
   - type: input
     id: version
     attributes:
-      label: Sunshine Version
+      label: Sunshine commit or version
       placeholder: eg. 0.14.0
     validations:
       required: true
-  - type: input
+  - type: dropdown
+    id: package_type
+    attributes:
+      label: Package
+      description: The package you installed
+      options:
+        - Linux - AppImage
+        - Linux - deb
+        - Linux - flatpak
+        - Linux - rpm
+        - macOS - dmg
+        - macOS - Portfile
+        - macOS - pkg
+        - Windows - installer
+        - Windows - portable
+        - other (not listed)
+        - other (self built)
+        - other (fork of this repo)
+  - type: dropdown
     id: graphics_type
     attributes:
       label: GPU Type
       description: The type of the installed graphics card.
-      placeholder: e.g. Intel, AMD, Nvidia
+      options:
-    validations:
+        - AMD
-      required: true
+        - Intel
+        - Nvidia
+        - none (software encoding)
   - type: input
     id: graphics_model
     attributes:
@@ -83,8 +121,8 @@ body:
     id: capture_method
     attributes:
       label: Capture Method (Linux Only)
-      description: The driver/mesa version of the installed graphics card.
+      description: If on Linux, the capture method being used.
-      placeholder: e.g. PipeWire/KVM/X11
+      placeholder: e.g. PipeWire/KVM/X11/KMS
     validations:
       required: false
   - type: textarea

README.rst

@@ -2,7 +2,7 @@
 
 Overview
 ========
-LizardByte has the full documentation hosted on `Read the Docs <https://docs.lizardbyte.dev/projects/sunshine/>`_.
+LizardByte has the full documentation hosted on `Read the Docs <https://sunshinestream.readthedocs.io/>`_.
 
 About
 -----
@@ -48,7 +48,8 @@ Integrations
 Support
 ---------
 
-Our support methods are listed in our `LizardByte Docs <https://docs.lizardbyte.dev/en/latest/about/support.html>`_.
+Our support methods are listed in our
+`LizardByte Docs <https://lizardbyte.readthedocs.io/en/latest/about/support.html>`_.
 
 Downloads
 ---------
@@ -57,11 +58,16 @@ Downloads
    :alt: GitHub Releases
    :target: https://github.com/LizardByte/Sunshine/releases/latest
 
+.. image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine?style=for-the-badge&logo=docker
+   :alt: Docker
+   :target: https://hub.docker.com/r/lizardbyte/sunshine
+
+Stats
+------
+.. image:: https://img.shields.io/github/stars/lizardbyte/sunshine?logo=github&style=for-the-badge
+   :alt: GitHub stars
+   :target: https://github.com/LizardByte/Sunshine
+
 .. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=AUR&style=for-the-badge&query=$.results.0.NumVotes&url=https%3A%2F%2Fapp.lizardbyte.dev%2Funo%2Faur%2Fsunshine.json&logo=archlinux
    :alt: AUR votes
    :target: https://aur.archlinux.org/packages/sunshine
-
-.. comment
-   image:: https://img.shields.io/docker/pulls/lizardbyte/sunshine?style=for-the-badge&logo=docker
-   :alt: Docker
-   :target: https://hub.docker.com/r/lizardbyte/sunshine

docs/source/about/installation.rst

@@ -124,10 +124,16 @@ Flatpak Package
 
 Start:
 
+   X11 and NVFBC capture (X11 Only)
       .. code-block:: bash
 
          flatpak run dev.lizardbyte.sunshine
 
+   KMS capture (Wayland & X11)
+      .. code-block:: bash
+
+         sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') flatpak run dev.lizardbyte.sunshine
+
 Uninstall:
 
    .. code-block:: bash

docs/source/about/usage.rst

@@ -67,20 +67,10 @@ Sunshine needs access to `uinput` to create mouse and gamepad events.
          sudo usermod -a -G input $USER
 
 #. Create `udev` rules.
-      .. code-block:: bash
-
-         sudo nano /etc/udev/rules.d/85-sunshine.rules
-
-      Input the following contents.
-
       .. code-block::
 
-         KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"
+         echo 'KERNEL=="uinput", GROUP="input", MODE="0660", OPTIONS+="static_node=uinput"' | \
-
+         sudo tee /etc/udev/rules.d/85-sunshine-input.rules
-      Save the file and exit:
-
-         #. ``CTRL+X`` to start exit.
-         #. ``Y`` to save modifications.
 
 #. Optionally, configure autostart service
       - filename: ``~/.config/systemd/user/sunshine.service``

docs/source/troubleshooting/general.rst

@@ -11,3 +11,12 @@ If you forgot your credentials to the web UI, try this.
 Can't access the web UI?
 
    #. Check firefall rules.
+
+NvFBC, NvENC, or general issues with Nvidia graphics card.
+
+   - Consume grade Nvidia cards are software limited to a specific number of encodes. See
+     `Video Encode and Decode GPU Support Matrix <https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new>`_
+     for more info.
+   - You can usually bypass the restriction with a driver patch. See Keylase's
+     `Linux <https://github.com/keylase/nvidia-patch>`_
+     or `Windows <https://github.com/keylase/nvidia-patch/blob/master/win>`_ patches for more guidance.