docs(v3): rewrite the FAQ with accurate platform support and verified v3 commands#5763
Conversation
… 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.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThe 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. ChangesFAQ v3 rewrite
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
… FAQ with accurate platform support and verified v3 commands
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.
Description
The FAQ predated much of current v3 and had drifted badly. This rewrites it end to end:
-tags gtk3option until v3.1, iOS/Android experimental, server build mentioned.wails3 build -platform ...and manual-ldflagsadvice replaced with the real v3 commands from the build guides (wails3 build GOOS=...,wails3 task darwin:build:universal,wails3 package).Events.On,app.Dialog.OpenFile()chain,app.SystemTray.New()), and every internal link checked against an existing docs page.wails3 doctorfirst, build-failure checklist, how to report a bug well.No version-channel wording is introduced; the page stays accurate regardless of release naming.
Type of change
Checklist
Summary by CodeRabbit