Merged
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4597 +/- ##
=========================================
Coverage ? 15.13%
=========================================
Files ? 95
Lines ? 19883
Branches ? 9196
=========================================
Hits ? 3009
Misses ? 15699
Partials ? 1175
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Bundle ReportBundle size has no change ✅ |
ReenigneArcher
force-pushed
the
docs/general-improvements
branch
2 times, most recently
from
9ec3d17 to
38bc6fa
Compare
ReenigneArcher
changed the title
ReenigneArcher
force-pushed
the
docs/general-improvements
branch
2 times, most recently
from
1fb2137 to
fb6f9d8
Compare
Added a tip for installing the beta version using 'sunshine-beta' and included 'brew update' and 'brew upgrade' steps before installation on macOS to ensure users have the latest Homebrew packages.
Corrected 'he tray icon' to 'the tray icon' in a comment explaining a Windows-specific issue with the system tray icon.
Add UI screenshots and a ViGEmBus installer image to the getting_started guide, reorganize and clarify the usage steps (theme selection, adding apps, config search, featured apps, PIN flow), and reword the config-file note to be optional. Add new image assets under docs/images for the updated UI walkthrough and troubleshooting logs.
Improve the bug report issue template to guide reporters and reduce noise. Add a prominent warning in the bug description that log errors are not bugs and add FreeBSD to OS options. Rename and clarify Windows package entries, add XDG Portal Grab capture option, and remove the old version and config fields to simplify the form. Update the logs section label/description, make logs optional, and add a new optional "Online logs" input so users can paste a gist link for long logs.
Differentiate the error message when a DRM framebuffer handle cannot be obtained. Use preprocessor guards to show a specific message for AppImage/Flatpak builds (SUNSHINE_BUILD_FLATPAK or SUNSHINE_BUILD_APPIMAGE) indicating KMS capture is not supported there; for other builds instruct users to use the 'sunshine-kms' service and provide stable and beta documentation links. This clarifies guidance and improves troubleshooting.
ReenigneArcher
force-pushed
the
docs/general-improvements
branch
from
fb6f9d8 to
750df71
Compare
Update the 'Stable builds' note to say the beta copr is often recommended but regular updates aren't required, while warning that rare breaking changes could cause occasional annoyances. Small documentation clarification in getting_started.md.
2 tasks
Update getting_started.md to clarify runtime and capture limitations for portable packages. Removed the AppImage distro matrix and added notes that AppImage does not support KMS capture and is built on Ubuntu 22.04 (requires glibc >= 2.35 and libstdc++ >= 3.4.11). Also added a caution that Flatpak does not support KMS capture. This makes compatibility requirements and capture limitations clearer for users.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documentation improvements.
Screenshot
Issues Fixed or Closed
sunshine-kmsservice #4666Roadmap Issues
Type of Change
Checklist
AI Usage