diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index e01de0aa..2a23e1bc 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -29,7 +29,7 @@ Example To manually configure sunshine you may edit the `conf` file in a text editor. Use the examples as reference. -.. Note:: Some settings are not available within the web ui. +.. Hint:: Some settings are not available within the web ui. General ------- @@ -166,7 +166,7 @@ Description .. Tip:: See `virtual key codes `_ - .. Note:: keybindings needs to have a multiple of two elements. + .. Hint:: keybindings needs to have a multiple of two elements. Default None diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst index 14ee37d2..70fd28c2 100644 --- a/docs/source/about/installation.rst +++ b/docs/source/about/installation.rst @@ -45,7 +45,7 @@ Red Hat Packages #. Download the corresponding `.rpm` file, e.g. ``sunshine-fedora_35.rpm`` #. ``sudo rpm -i ``, e.g. ``sudo rpm -i ./sunshine-fedora_35.rpm`` -.. Note:: If this is the first time installing. +.. Hint:: If this is the first time installing. .. code-block:: bash diff --git a/docs/source/about/third_party_packages.rst b/docs/source/about/third_party_packages.rst index 4f349abe..6069258a 100644 --- a/docs/source/about/third_party_packages.rst +++ b/docs/source/about/third_party_packages.rst @@ -3,7 +3,7 @@ Third Party Packages ==================== -.. Warning:: These packages are not maintained by SunshineStream. Use at your own risk. +.. Danger:: These packages are not maintained by SunshineStream. Use at your own risk. AUR (Arch Linux User Repository) -------------------------------- @@ -51,6 +51,8 @@ Scoop Legacy GitHub Repo ------------------ +.. Attention:: This repo is no longer maintained. Thank you to Loki for bringing this amazing project to life! + .. image:: https://img.shields.io/github/last-commit/loki-47-6F-64/sunshine?style=for-the-badge&logo=github :alt: GitHub last commit diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst index 6eafe4b9..4bb81bc5 100644 --- a/docs/source/about/usage.rst +++ b/docs/source/about/usage.rst @@ -5,7 +5,9 @@ Usage #. See the `setup`_ section for your specific OS. #. Run ``sunshine /sunshine.conf``. - .. Note:: The configuration file specified will be created if it doesn't exist. + .. Note:: You do not need to specify a config file. If no config file is entered the default location will be used. + + .. Attention:: The configuration file specified will be created if it doesn't exist. .. Tip:: If using the Linux AppImage, replace ``sunshine`` with ``./sunshine.AppImage`` @@ -13,7 +15,7 @@ Usage The web ui is available on `https://localhost:47990 `_ by default. You may replace `localhost` with your internal ip address. - .. Tip:: Ignore any warning given by your browser about "insecure website". + .. Attention:: Ignore any warning given by your browser about "insecure website". .. Caution:: If running for the first time, make sure to note the username and password Sunshine showed to you, since you cannot get back later! @@ -24,7 +26,7 @@ Usage .. Note:: Additionally, apps can be configured manually. `assets/apps_.json` is an example of a list of applications that are started just before running a stream. - .. Note:: Application list is not fully supported on MacOS + .. Attention:: Application list is not fully supported on MacOS #. In Moonlight, you may need to add the PC manually. #. When Moonlight request you insert the correct pin on sunshine: @@ -38,7 +40,7 @@ Network ------- Sunshine will be available on port 47990 by default. -.. Warning:: Do not expose port 47990, or the web ui, to the internet! +.. Danger:: Do not expose port 47990, or the web ui, to the internet! Arguments --------- diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index 15ff0001..a519761a 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -5,7 +5,7 @@ Linux Requirements ------------ -.. Warning:: Installing these dependencies may break your distribution. It is recommended to build in a virtual machine +.. Danger:: Installing these dependencies may break your distribution. It is recommended to build in a virtual machine or to use the `Dockerfile builds`_ located in the `./scripts` directory. Debian Bullseye @@ -223,7 +223,7 @@ End of Life: April 2027 Build ----- -.. Caution:: Ensure you are in the build directory created during the clone step earlier before continuing. +.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. Debian based OSes .. code-block:: bash diff --git a/docs/source/building/macos.rst b/docs/source/building/macos.rst index c763ad12..97a58a23 100644 --- a/docs/source/building/macos.rst +++ b/docs/source/building/macos.rst @@ -28,7 +28,7 @@ Install Requirements Build ----- -.. Caution:: Ensure you are in the build directory created during the clone step earlier before continuing. +.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. .. code-block:: bash diff --git a/docs/source/building/windows.rst b/docs/source/building/windows.rst index 6a7c1e16..36cea881 100644 --- a/docs/source/building/windows.rst +++ b/docs/source/building/windows.rst @@ -14,7 +14,7 @@ following packages using: Build ----- -.. Caution:: Ensure you are in the build directory created during the clone step earlier before continuing. +.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. .. code-block:: batch diff --git a/docs/source/contributing/localization.rst b/docs/source/contributing/localization.rst index 6d0f6556..721ebc61 100644 --- a/docs/source/contributing/localization.rst +++ b/docs/source/contributing/localization.rst @@ -22,7 +22,7 @@ The translations occur on `CrowdIn `_. Feel free to contribute to localization there. Only elements of the API are planned to be translated. -.. Note:: The rest API has not yet been implemented. +.. Attention:: The rest API has not yet been implemented. Translations Basics - The brand names `SunshineStream` and `Sunshine` should never be translated.