Skip to content

docs(v3): rewrite the FAQ with accurate platform support and verified v3 commands#5763

Merged
leaanthony merged 1 commit into
masterfrom
docs/faq-overhaul
Jul 6, 2026
Merged

docs(v3): rewrite the FAQ with accurate platform support and verified v3 commands#5763
leaanthony merged 1 commit into
masterfrom
docs/faq-overhaul

Conversation

@taliesin-ai

@taliesin-ai taliesin-ai commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Description

The FAQ predated much of current v3 and had drifted badly. This rewrites it end to end:

  • Platform support corrected (was: Windows 7+, macOS 10.13+, Linux GTK3). Now matches the installation docs: Windows 10/11 (WebView2, AMD64/ARM64), macOS 10.15+ Intel / 11+ Apple Silicon (deploy target 10.13+), Linux GTK4 + WebKitGTK 6.0 default with the legacy -tags gtk3 option until v3.1, iOS/Android experimental, server build mentioned.
  • v2-style commands removed: wails3 build -platform ... and manual -ldflags advice replaced with the real v3 commands from the build guides (wails3 build GOOS=..., wails3 task darwin:build:universal, wails3 package).
  • Electron comparison table removed; Wails benefits stated on their own terms.
  • Every snippet verified against v3 source/examples (bindings import shape, Events.On, app.Dialog.OpenFile() chain, app.SystemTray.New()), and every internal link checked against an existing docs page.
  • Added the questions new users actually ask: prerequisites, wails3 doctor first, build-failure checklist, how to report a bug well.
  • Production-readiness answer now points at the status page instead of overpromising.

No version-channel wording is introduced; the page stays accurate regardless of release naming.

Type of change

  • Documentation

Checklist

  • English source only; translations re-sync via the pipeline

Summary by CodeRabbit

  • Documentation
    • Updated the FAQ for Wails v3 with refreshed getting-started guidance, platform requirements, and framework compatibility details.
    • Expanded build, packaging, signing, and cross-compilation instructions for current v3 workflows.
    • Revised feature notes for multi-window support, system tray, native dialogs, auto-updates, and event handling.
    • Reworked troubleshooting and migration content to match v3 commands and behavior, and refreshed community links and examples.

… v3 commands

The FAQ predated much of current v3 and had drifted badly:

- Platform support said Windows 7+, macOS 10.13+ and Linux GTK3. Now
  matches the installation docs: Windows 10/11 (WebView2, AMD64/ARM64),
  macOS 10.15+/11+ (deploy target 10.13+), Linux GTK4 + WebKitGTK 6.0
  default with the legacy gtk3 tag option, iOS/Android experimental,
  plus the server build.
- Build answers used v2-style commands that do not exist in v3
  (wails3 build -platform ..., manual -ldflags advice). Replaced with
  the real commands from the build guides (wails3 build GOOS=...,
  wails3 task darwin:build:universal, wails3 package) and a note that
  production defaults already strip binaries.
- Removed the Electron comparison table in favour of stating what
  Wails does well on its own terms.
- Every API snippet is now verified against v3 source and examples
  (GreetService bindings import, Events.On, app.Dialog.OpenFile
  chain, app.SystemTray.New) and every internal link resolves to an
  existing page.
- Added the questions new users actually ask: prerequisites,
  wails3 doctor as the first troubleshooting step, build-failure
  checklist, how to report a bug.
- Softened the production-readiness answer to point at the status
  page instead of overpromising.
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 49a79e60-19e0-41f3-9a64-0b71a4cf9c8f

📥 Commits

Reviewing files that changed from the base of the PR and between 77fbbfa and dd33dd1.

📒 Files selected for processing (1)
  • docs/src/content/docs/faq.mdx

Walkthrough

The FAQ documentation page (faq.mdx) is rewritten to focus on Wails v3, replacing prior v2-oriented content with v3-specific guidance on platform requirements, bindings generation, event handling, build/distribution workflows, features, troubleshooting, migration, and community resources.

Changes

FAQ v3 rewrite

Layer / File(s) Summary
Front matter and General FAQ section
docs/src/content/docs/faq.mdx
Description updated to target Wails v3; General section rewritten with platform requirements table, updated getting-started/production-ready guidance, frontend framework support, JS↔Go bindings generation, event wiring examples using app.Event.Emit/Events.On, and wails3 dev-based debugging.
Build, distribution, features, troubleshooting, migration, community
docs/src/content/docs/faq.mdx
Cross-compilation, wails3 package, and signing guidance expanded; Features section updated for multi-window, tray, dialogs, and auto-updater; Troubleshooting rewritten with wails3 doctor/bindings regeneration; Migration and Community sections refreshed for v3.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • wailsapp/wails#4476: Related documentation changes migrating event registration/emission examples to the same app.Event.* API pattern.

Suggested labels: Documentation, size:L

Suggested reviewers: leaanthony

Poem

A rabbit hops through docs anew,
v2 fades, v3 breaks through,
Tables of platforms, commands so neat,
wails3 dev makes the hop complete,
Hooray for FAQs, crisp and true! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR’s main change: a v3 FAQ rewrite with updated platform support and commands.
Description check ✅ Passed The description is detailed and on-topic, covering motivation, scope, and change type, though it omits the issue link and testing section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/faq-overhaul

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@leaanthony leaanthony merged commit 646512e into master Jul 6, 2026
33 checks passed
leaanthony pushed a commit that referenced this pull request Jul 6, 2026
… FAQ with accurate platform support and verified v3 commands
taliesin-ai pushed a commit that referenced this pull request Jul 6, 2026
The rewritten FAQ (cherry-picked from PR #5763) uses channel-neutral
wording on master. On this branch the answer matches the staged beta
banners: in beta, API stable, final polish before 3.0.
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.

2 participants