docs(v3): add missing docs for build tags, GTK4, and icon composer - #5071
Conversation
…mposer Document the -tags flag for wails3 build (CLI reference + building guide), add GTK4 experimental support guide with dependencies and known differences, and document the -iconcomposerinput/-macassetdir flags for icon generation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Deploying wails with
|
| Latest commit: |
5f8971e
|
| Status: | 🚫 Build failed. |
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughDocumentation and doctor packagemanager updates adding a Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR closes documentation gaps in the v3 docs around passing custom build tags, enabling experimental Linux GTK4 builds, and generating macOS Icon Composer-based icons, aligning the docs with recent v3-alpha feature work.
Changes:
- Documented
wails3 build -tagsusage and how tags flow into Taskfiles. - Added “Custom Build Tags” guidance (GTK4/server examples) and a new “GTK4 Support (Experimental)” section in Linux packaging docs.
- Expanded CLI docs for
wails3 generate iconswith Icon Composer / macOS asset catalog flags and usage.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/quick-start/installation.mdx | Adds an installation note pointing Linux users to optional GTK4/WebKitGTK 6.0 setup and build tag usage. |
| docs/src/content/docs/guides/cli.mdx | Documents -tags on wails3 build and adds Icon Composer / macOS asset generation flags and guidance for generate icons. |
| docs/src/content/docs/guides/build/linux.mdx | Adds a comprehensive GTK4 (experimental) section: dependencies, build commands, and behavioral differences vs GTK3. |
| docs/src/content/docs/guides/build/building.mdx | Adds a “Custom Build Tags” section with examples and links to related guides. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
v3 requires webkit2gtk-4.1 (pkg-config name) but the quick-start install commands and doctor output example still referenced the older 4.0 packages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
…overage - Fix Arch: webkit2gtk → webkit2gtk-4.1 (correct package for 4.1 API) - Add openSUSE tab: webkit2gtk4_1-devel - Add Gentoo tab: net-libs/webkit-gtk:4.1 - Add NixOS tab: pkgs.webkitgtk_4_1 - Add caution note: WebKitGTK 4.1 is required; Ubuntu 20.04, Debian 11, and RHEL 8/9 only ship 4.0 and are not supported Package names sourced from wails3 doctor packagemanager implementations. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
…hecks Wails v3 requires webkit2gtk-4.1 at compile time (CGO pkg-config directive). The fallback entries would pass doctor's availability check but still fail at build time, giving users a misleading "all clear". - dnf: remove webkit2gtk3-devel (4.0 API) - zypper: remove webkit2gtk3-soup2-devel (libsoup2 = 4.0 API) - pacman: remove webkit2gtk (unversioned, 4.0 API on modern Arch) - nixpkgs: webkitgtk → webkitgtk_4_1 (correct package name for 4.1 API) Also update NixOS entry in installation docs to match. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
…devel webkit2gtk4_1-devel does not exist on openSUSE. The correct package is webkit2gtk3-devel, which ships both the 4.0 (soup2) and 4.1 (soup3) API variants from the same source package. Also update the openSUSE tab in the installation docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Summary
-tagsflag onwails3 buildand the-iconcomposerinput/-macassetdirflags onwails3 generate icons-tags gtk4,-tags server, and combined tagswails3 doctor: Remove WebKitGTK 4.0 fallback entries that would pass the dependency check but still fail at build timeWhat was wrong with the Linux docs
Wails v3 hardcodes
webkit2gtk-4.1in its CGO pkg-config directives and purego runtime loader. The installation guide was pointing users at 4.0 packages, which:pkg-config: webkit2gtk-4.1 not found)Additionally,
wails3 doctorhad 4.0 fallback entries (e.g.webkit2gtk3-develon Fedora,webkit2gtk3-soup2-develon openSUSE, unversionedwebkit2gtkon Arch) that would mark the dependency as satisfied even though the build would still fail. These have been removed.Linux dependency changes
libwebkit2gtk-4.0-devlibwebkit2gtk-4.1-devwebkit2gtk4.0-develwebkit2gtk4.1-develwebkit2gtkwebkit2gtk-4.1webkit2gtk4_1-develnet-libs/webkit-gtk:4.1webkitgtk_4_1A caution note now explains that Ubuntu 20.04, Debian 11, and RHEL 8/9 only ship WebKitGTK 4.0 and are not supported.
Test plan
-tagsflag examples match actual CLI behaviorwails3 doctorno longer suggests 4.0 packages on Fedora, openSUSE, Arch, and NixOS🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation
Bug Fixes