Skip to content

fix(web-ui): add documentation link and version-aware URLs#5176

Merged
ReenigneArcher merged 1 commit into
masterfrom
clarify-env-variables
May 24, 2026
Merged

fix(web-ui): add documentation link and version-aware URLs#5176
ReenigneArcher merged 1 commit into
masterfrom
clarify-env-variables

Conversation

@ReenigneArcher
Copy link
Copy Markdown
Member

Description

Add a Documentation button to ResourceCard and make docs links version-aware based on installed vs GitHub release. ResourceCard: register BookOpen icon, new installedVersionNotStable prop and documentationUrl computed property. App shell (apps.html/index.html): import SunshineVersion, fetch local version from ./api/config and latest GitHub release, compare versions to determine documentationBaseUrl and pass installedVersionNotStable into Resource-Card. Add "documentation" localization string to en.json. Docs: replace ~ with $(HOME) in app examples for clarity. AGENTS.md: add note to only update the en localization (no locale variants).

Screenshot

Issues Fixed or Closed

Roadmap Issues

Type of Change

  • feat: New feature (non-breaking change which adds functionality)
  • fix: Bug fix (non-breaking change which fixes an issue)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit
  • BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

  • Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Code has been commented, particularly in hard-to-understand areas
  • Code docstring/documentation-blocks for new or existing methods/components have been added or updated
  • Unit tests have been added or updated for any new or modified functionality

AI Usage

  • None: No AI tools were used in creating this PR
  • Light: AI provided minor assistance (formatting, simple suggestions)
  • Moderate: AI helped with code generation or debugging specific parts
  • Heavy: AI generated most or all of the code changes

Add a Documentation button to ResourceCard and make docs links version-aware based on installed vs GitHub release. ResourceCard: register BookOpen icon, new installedVersionNotStable prop and documentationUrl computed property. App shell (apps.html/index.html): import SunshineVersion, fetch local version from ./api/config and latest GitHub release, compare versions to determine documentationBaseUrl and pass installedVersionNotStable into Resource-Card. Add "documentation" localization string to en.json. Docs: replace ~ with $(HOME) in app examples for clarity. AGENTS.md: add note to only update the `en` localization (no locale variants).
@codecov
Copy link
Copy Markdown

codecov Bot commented May 24, 2026

Bundle Report

Changes will increase total bundle size by 1.41kB (0.09%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sunshine-esm 796.04kB 1.41kB (0.18%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sunshine-esm

Assets Changed:

Asset Name Size Change Total Size Change (%)
assets/createLucideIcon-*.js 30 bytes 356.7kB 0.01%
assets/index-*.js -965 bytes 45.89kB -2.06%
assets/apps-*.js 532 bytes 12.49kB 4.45%
assets/ResourceCard-*.js 777 bytes 2.63kB 41.82% ⚠️
assets/sunshine_version-*.js (New) 1.03kB 1.03kB 100.0% 🚀

Files in assets/createLucideIcon-*.js:

  • ./src_assets/common/assets/web/public/assets/locale/en.json → Total Size: 40.04kB

Files in assets/index-*.js:

  • ./src_assets/common/assets/web/index.html → Total Size: 0 bytes

Files in assets/apps-*.js:

  • ./src_assets/common/assets/web/apps.html → Total Size: 0 bytes

Files in assets/ResourceCard-*.js:

  • ./src_assets/common/assets/web/ResourceCard.vue → Total Size: 4.41kB

@sonarqubecloud
Copy link
Copy Markdown

@codecov
Copy link
Copy Markdown

codecov Bot commented May 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 16.14%. Comparing base (7822c1f) to head (1f36a0c).
✅ All tests successful. No failed tests found.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5176      +/-   ##
==========================================
+ Coverage   15.61%   16.14%   +0.52%     
==========================================
  Files         110      111       +1     
  Lines       23648    23305     -343     
  Branches    10393    10410      +17     
==========================================
+ Hits         3693     3762      +69     
+ Misses      17690    15359    -2331     
- Partials     2265     4184    +1919     
Flag Coverage Δ
Archlinux 11.21% <ø> (ø)
FreeBSD-aarch64 ?
Linux-AppImage 12.13% <ø> (ø)
Windows-AMD64 14.85% <ø> (?)
Windows-ARM64 13.20% <ø> (ø)
macOS-arm64 18.96% <ø> (?)
macOS-x86_64 18.33% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 86 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7822c1f...1f36a0c. Read the comment docs.

@ReenigneArcher ReenigneArcher merged commit 68f6718 into master May 24, 2026
70 of 74 checks passed
@ReenigneArcher ReenigneArcher deleted the clarify-env-variables branch May 24, 2026 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant