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

Open
leaanthony wants to merge 1 commit into
base: master
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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:
```
go install github.com/wailsapp/wails/v3/cmd/wails3@latest
wails3 init -n myapp
```
Comment on lines +14 to +17
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 21, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language identifier to code block.

The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and better readability.

📝 Proposed fix 
-```
+```bash
 go install github.com/wailsapp/wails/v3/cmd/wails3@latest
 wails3 init -n myapp
</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>

[warning] 14-14: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @v3/README.md around lines 14 - 17, The README's fenced code block lacks a
language identifier; update the block that contains the commands "go install
github.com/wailsapp/wails/v3/cmd/wails3@latest" and "wails3 init -n myapp" to
include a shell language tag (e.g., change the opening tobash or

syntax highlighting.


## 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.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 21, 2026

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

🏁 Script executed:

#!/bin/bash
# Description: Check if v3/STABILITY.md exists and preview its content

# Check if the file exists
if [ -f "v3/STABILITY.md" ]; then
  echo "✓ v3/STABILITY.md exists"
  echo ""
  echo "File preview (first 20 lines):"
  head -n 20 "v3/STABILITY.md"
else
  echo "✗ v3/STABILITY.md not found"
  exit 1
fi

Repository: wailsapp/wails

Length of output: 86

Fix missing v3/STABILITY.md target for the README link.

v3/README.md links to STABILITY.md, but v3/STABILITY.md is not present in the repository (link target is currently broken, so the stability policy reference can’t be resolved).

Run v3/README.md → STABILITY.md link target to a real existing file or add the missing v3/STABILITY.md with the referenced policy.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@v3/README.md` at line 27, The README link in v3/README.md points to
v3/STABILITY.md which does not exist; either add the missing file named
STABILITY.md under the v3 directory containing the stability policy, or update
the link in v3/README.md to point to the actual existing stability policy file
(e.g., ../STABILITY.md or correct path). Ensure the chosen resolution uses the
exact filename "STABILITY.md" and that the link target matches the repository
structure so the reference resolves.


## 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