Skip to content

Asdr doc fix #4932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AbdelhadiSeddar wants to merge 2 commits into from
Closed

Asdr doc fix #4932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35afc21
[skip ci] Publish @wailsio/runtime v3.0.0-alpha.80
invalid-email-address Jan 29, 2026
daee492
fix versions and use of wails instead of wails3
AbdelhadiSeddar Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/content/docs/getting-started/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { Tabs, TabItem } from "@astrojs/starlight/components";
Wails has a number of common dependencies that are required before installation:

<Tabs>
<TabItem label="Go (At least 1.24)" icon="seti:go">
<TabItem label="Go (At least 1.25)" icon="seti:go">

Download Go from the [Go Downloads Page](https://go.dev/dl/).

Expand Down Expand Up @@ -64,12 +64,12 @@ You will also need to install platform specific dependencies:
</TabItem>
<TabItem label="Windows" icon="seti:windows">

Wails requires that the [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) is installed. Almost all Windows installations will already have this installed. You can check using the `wails doctor` command.
Wails requires that the [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) is installed. Almost all Windows installations will already have this installed. You can check using the `wails3 doctor` command.

</TabItem>
<TabItem label="Linux" icon="linux">

Linux requires the standard `gcc` build tools plus `gtk3` and `webkit2gtk`. Run <code>wails doctor</code> after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please let us know on discord.
Linux requires the standard `gcc` build tools plus `gtk3` and `webkit2gtk`. Run <code>wails3 doctor</code> after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please let us know on discord.

</TabItem>

Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/quick-start/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,13 @@ If `wails3 doctor` passes, you're done. [Skip to First App →](/quick-start/fir
<TabItem label="Ubuntu/Debian">
```bash
sudo apt update
sudo apt install build-essential pkg-config libgtk-3-dev libwebkit2gtk-4.0-dev
sudo apt install build-essential pkg-config libgtk-3-dev libwebkit2gtk-4.1-dev
```
</TabItem>

<TabItem label="Fedora">
```bash
sudo dnf install gcc pkg-config gtk3-devel webkit2gtk4.0-devel
sudo dnf install gcc pkg-config gtk3-devel webkit2gtk4.1-devel
Comment on lines +145 to +151

@coderabbitai coderabbitai Bot Jan 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🌐 Web query:

libwebkit2gtk-4.1-dev Ubuntu Debian official package repository

💡 Result:

Ubuntu (official archive / packages.ubuntu.com): libwebkit2gtk-4.1-dev is available in these Ubuntu series: jammy (22.04 LTS), noble (24.04 LTS), plucky (25.04), questing (25.10) (typically in universe, including security/updates pockets). [2][3][4][5]

Debian (official archive / packages.debian.org): libwebkit2gtk-4.1-dev is available in bookworm (oldstable), bookworm-backports, trixie (stable), forky (testing), sid (unstable), and experimental. [1]

🌐 Web query:

webkit2gtk4.1-devel Fedora official package repository

💡 Result:

webkit2gtk4.1-devel is available in Fedora’s official repositories as a subpackage of webkitgtk (development headers/libs for webkit2gtk4.1). [1]

  • Fedora Rawhide: 2.51.90-2.fc44
  • Fedora 43: 2.50.4-1.fc43 (stable), 2.50.0-2.fc43 (testing)
  • Fedora 42: 2.50.4-1.fc42
  • EPEL 10.2: 2.48.3-1.el10_1
  • EPEL 10.1: 2.50.4-2.el10_1 [1]

Install:

sudo dnf install webkit2gtk4.1-devel

Sources: [1]

🌐 Web query:

WebKitGTK 4.1 development headers package name Ubuntu 22.04 24.04 Debian 12 13

💡 Result:

Citations:

🌐 Web query:

webkit2gtk 4.1 devel Fedora 39 40 41 RHEL package

💡 Result:

  • Fedora 40 / 41: install webkit2gtk4.1-devel (subpackage of webkitgtk). [1]

    • Example: sudo dnf install webkit2gtk4.1-devel
    • Provides pkgconfig(webkit2gtk-4.1) and pkgconfig(webkit2gtk-web-extension-4.1) (via the -devel RPM). [1]

  • Fedora 39: there is no webkit2gtk4.1-devel; Fedora 39 ships the older API as webkit2gtk4.0-devel. [2]

  • RHEL: webkit2gtk4.1-devel is available via EPEL 10 (i.e., for RHEL/CentOS Stream 10 family), as webkit2gtk4.1-devel. [1][3][4]

    • If you’re on RHEL 8/9, EPEL 10 packages won’t apply; you’d typically be on the 4.0 API series instead (or need a newer OS / alternative packaging).

Sources: Fedora package pages for webkit2gtk4.1-devel and EPEL builds, plus Fedora 39 webkit2gtk4.0-devel. [1][2][3][4]

🏁 Script executed:

# Check the installation documentation for supported distro versions
fd -t f "installation" docs/ | head -5
cat docs/src/content/docs/quick-start/installation.mdx | head -200

Repository: wailsapp/wails

Length of output: 5672

🏁 Script executed:

# Look for any version requirements or distro support matrix
rg -i "fedora.*39|fedora.*40|supported.*version" docs/ -A 2 -B 2

Repository: wailsapp/wails

Length of output: 1476

🏁 Script executed:

# Check for system requirements or version constraints in Wails v3 docs
rg "system.*requirement|support.*version|fedora.*version|minimum.*fedora" docs/ -i -A 3

Repository: wailsapp/wails

Length of output: 2065

🏁 Script executed:

# Check if there's a troubleshooting or FAQ section addressing Fedora 39
rg "fedora 39|webkit2gtk4.0" docs/ -i -A 2 -B 2

Repository: wailsapp/wails

Length of output: 1476

Fedora 39 compatibility issue with WebKitGTK dev package name.

Ubuntu/Debian package names are correct—libwebkit2gtk-4.1-dev is available on jammy (22.04), noble (24.04), bookworm, and trixie.

However, Fedora 39 does not include webkit2gtk4.1-devel; it only provides webkit2gtk4.0-devel. The current Fedora installation command will fail on Fedora 39. Since Wails v3 documentation references "Fedora 39+" support elsewhere (build guides, changelog), either:

  • Add version-specific handling to the Fedora tab (39 → webkit2gtk4.0-devel; 40+ → webkit2gtk4.1-devel), or
  • Explicitly document a minimum Fedora 40 requirement if 4.0 compatibility is dropped

Fedora 40+ and later correctly ship webkit2gtk4.1-devel.

🤖 Prompt for AI Agents 
In `@docs/src/content/docs/quick-start/installation.mdx` around lines 145 - 151,
Update the Fedora TabItem to handle Fedora 39 compatibility: either replace the
single install line under TabItem label="Fedora" with a short note and two
commands (Fedora 39: use webkit2gtk4.0-devel; Fedora 40+: use
webkit2gtk4.1-devel) or explicitly state a minimum requirement of Fedora 40 and
keep the existing command using webkit2gtk4.1-devel; edit the Fedora TabItem
content around the existing sudo dnf install gcc pkg-config gtk3-devel
webkit2gtk4.1-devel line to reflect the chosen approach.

```
</TabItem>

Expand Down Expand Up @@ -331,7 +331,7 @@ If `wails3 doctor` passes, you're done. [Skip to First App →](/quick-start/fir
**Linux:** The output tells you exactly which packages to install. Example:
```
❌ webkit2gtk not found
Install with: sudo apt install libwebkit2gtk-4.0-dev
Install with: sudo apt install libwebkit2gtk-4.1-dev
```

**Windows:** If WebView2 is missing:
Expand Down
2 changes: 2 additions & 0 deletions v3/UNRELEASED_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ After processing, the content will be moved to the main changelog and this file

## Changed
<!-- Changes in existing functionality -->
- Updated to use go v1.25 and wails3 instead of go v1.24 and wails in ..docs/getting-started/installation.mdx
- Updated to use of GTK WebKit Dev v4.1 instead v4.0 according to alpha.64 (v4.0 dev is depricated on some latest releases of linux distros) in ..docs/quick-start/installation.mdx

## Fixed
<!-- Bug fixes -->
Expand Down
4 changes: 2 additions & 2 deletions v3/internal/runtime/desktop/@wailsio/runtime/docs/classes/Call.RuntimeError.html
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions v3/internal/runtime/desktop/@wailsio/runtime/docs/classes/CancelError.html
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions v3/internal/runtime/desktop/@wailsio/runtime/docs/classes/CancellablePromise.html
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions v3/internal/runtime/desktop/@wailsio/runtime/docs/classes/CancelledRejectionError.html
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions v3/internal/runtime/desktop/@wailsio/runtime/docs/classes/Events.WailsEvent.html
View file
Open in desktop

Large diffs are not rendered by default.

106 changes: 53 additions & 53 deletions v3/internal/runtime/desktop/@wailsio/runtime/docs/classes/_internal_.Window.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Application.Hide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Hide | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Application.html">Application</a></li><li><a href="Application.Hide.html">Hide</a></li></ul><h1>Function Hide</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="hide" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Hide</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#hide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hides a certain method by calling the HideMethod function.</p>
</div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L21">src/application.ts:21</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
</div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L21">src/application.ts:21</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

@coderabbitai coderabbitai Bot Jan 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Source reference points to fork.

Same issue as noted in System.invoke.html — the "Defined in" link points to AbdelhadiSeddar/wails instead of the official wailsapp/wails repository.

🤖 Prompt for AI Agents 
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Hide.html
at line 2, The "Defined in" source link in the generated docs for
Application.Hide incorrectly points to the fork (AbdelhadiSeddar/wails); update
the TypeDoc/source link configuration or the source reference generation so the
link uses the official repository (wailsapp/wails) for the Application.Hide
entry (and likewise for System.invoke.html), ensuring the anchor points
(src/application.ts:21) remain unchanged while replacing the repository owner in
the URL.

Loading
Loading