Documentation: Specify how to handle the Fixed WebView Runtime. (#3444)

* Update `windows.mdx` Specify to the user that the WebView dependency must be extracted before being used. * Update no versioned `windows.mdx` * Update `changelog.mdx`
wailsapp · Jun 19, 2024 · 517d8d7 · 517d8d7
1 parent b0dfa86
commit 517d8d7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/website/docs/guides/windows.mdx b/website/docs/guides/windows.mdx
@@ -53,6 +53,12 @@ Also, you should specify path to fixed version of webview2 runtime in the `windo
 Note: When `WebviewBrowserPath` is specified, `error` strategy will be forced in case of minimal required version
 mismatch or invalid path to a runtime.
 
+The downloaded file will be compressed (extension `.cab`), so you must extract it before using it, according to the instructions on the [official site](https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#details-about-the-fixed-version-runtime-distribution-mode) should run in a terminal the following command to extract the file:
+
+```
+expand {path to the package} -F:* {path to the destination folder}
+```
+
 ## Spawning other programs
 
 When spawning other programs, such as scripts, you will see the window appear on the screen. To hide the window,

diff --git a/website/src/pages/changelog.mdx b/website/src/pages/changelog.mdx
@@ -68,6 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed some typos in comments. Changed by [@reallylowest](https://github.com/reallylowest) in [PR](https://github.com/wailsapp/wails/pull/3357)
 - Fixed an issue where the destination file was not properly closed after copying. Changed by [@testwill](https://github.com/testwill) in [PR](https://github.com/wailsapp/wails/pull/3384)
 - Fixed an issue where `xattr` calls were not working. Fixed by [@leaanthony](https://github.com/wailsapp/wails/pull/3328)
+- Warn in the documentation that the fixed version of the WebView 2 Runtime must be extracted before use. Documented by [@ALizarazoTellez](https://github.com/ALizarazoTellez) in [PR](https://github.com/wailsapp/wails/pull/3444).
 
 ### Changed
 

diff --git a/website/versioned_docs/version-v2.8.1/guides/windows.mdx b/website/versioned_docs/version-v2.8.1/guides/windows.mdx
@@ -53,6 +53,12 @@ Also, you should specify path to fixed version of webview2 runtime in the `windo
 Note: When `WebviewBrowserPath` is specified, `error` strategy will be forced in case of minimal required version
 mismatch or invalid path to a runtime.
 
+The downloaded file will be compressed (extension `.cab`), so you must extract it before using it, according to the instructions on the [official site](https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#details-about-the-fixed-version-runtime-distribution-mode) should run in a terminal the following command to extract the file:
+
+```
+expand {path to the package} -F:* {path to the destination folder}
+```
+
 ## Spawning other programs
 
 When spawning other programs, such as scripts, you will see the window appear on the screen. To hide the window,