Skip to content

docs(v3): update README — replace 'v3 Alpha' with Beta scope statement #5490

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

Merged
leaanthony merged 4 commits into from
Jun 13, 2026
Merged

docs(v3): update README — replace 'v3 Alpha' with Beta scope statement #5490

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6c1391
docs(v3): update README to v3 Beta with scope statement
taliesin-ai May 21, 2026
1b660b8
Merge branch 'master' into agent/beta-release-manager/d785cc4b
leaanthony Jun 13, 2026
0892f36
docs(v3): fix broken STABILITY.md link and add bash language hint
leaanthony Jun 13, 2026
4d5ab1c
Merge remote-tracking branch 'origin/master' into agent/beta-release-…
leaanthony Jun 13, 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
32 changes: 28 additions & 4 deletions v3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
# v3 Alpha
# Wails v3 Beta

Thanks for wanting to help out with testing/developing Wails v3! This guide will help you get started.
Welcome to Wails v3! This is the beta release of the next major version of Wails.

## What Beta means

The v3 API in `v3/pkg/application` and related packages is stable. We will not make breaking changes without a deprecation cycle and clear migration guidance.

## Getting Started

All the instructions for getting started are in the v3 documentation directory: `mkdocs-website`.
Please read the README.md file in that directory for more information.
Full documentation is available at [v3.wails.io](https://v3.wails.io).

To get started with a new project:
```
Comment thread
Copilot marked this conversation as resolved.
Outdated
go install github.com/wailsapp/wails/v3/cmd/wails3@latest
wails3 init -n myapp
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

## Beta scope — what's deferred

The following areas are still under active development and are **not** covered by the v3 stability guarantee:

- **iOS / Android**: Not production-ready in v3 beta; deferred to a future release.
- **GTK4 Linux backend**: Now the default on Linux but still in active stabilisation. Some rendering edge cases may remain.
- **Some niche AppKit APIs**: A small number of macOS-specific window APIs are still being finalised.

See [`v3/STABILITY.md`](STABILITY.md) for the full stability policy.

@leaanthony leaanthony Jun 13, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Removed the dangling link — v3/STABILITY.md doesn't exist yet. Replaced with an inline note: 'The items listed above may have breaking changes without a deprecation cycle.' which conveys the same information without a broken cross-reference.

Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

## Giving feedback

- **Bug reports**: [github.com/wailsapp/wails/issues](https://github.com/wailsapp/wails/issues)
- **Discussions**: [github.com/wailsapp/wails/discussions](https://github.com/wailsapp/wails/discussions)
- **Discord**: [wails.io/discord](https://wails.io/discord)
Loading