Skip to content

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

Merged
leaanthony merged 4 commits into
masterfrom
agent/beta-release-manager/d785cc4b
Jun 13, 2026
Merged

docs(v3): update README — replace 'v3 Alpha' with Beta scope statement#5490
leaanthony merged 4 commits into
masterfrom
agent/beta-release-manager/d785cc4b

Conversation

@leaanthony

@leaanthony leaanthony commented May 21, 2026

Copy link
Copy Markdown
Member

Summary

Updates v3/README.md from the placeholder "v3 Alpha" text to a proper Beta README that includes:

  • Title: "Wails v3 Beta"
  • What Beta means: stable API guarantee for v3/pkg/application
  • Getting Started: link to docs site and install instructions
  • Beta scope: deferred items (iOS/Android, GTK4, some AppKit APIs)
  • Feedback: links to GitHub Issues, Discussions, Discord

Context

This is beta readiness criterion #6: v3/README.md must have a Beta scope statement. The PR was prepared previously by Engineer - Mac on branch agent/engineer-mac/32d5ccad but could not be pushed due to an invalid GH_TOKEN at the time (tracked in WAI-324). GH_TOKEN is now working, so this PR opens the change directly from the beta-release-manager agent.

CC @leaanthony

Summary by CodeRabbit

  • Documentation
    • v3 release notes rewritten to reflect Beta status and clarify API stability
    • "What Beta means" section added to set expectations for the v3 API
    • Updated Getting Started guidance with clearer installation and init commands
    • "Beta scope" section lists platform/backend areas deferred for later
    • Added "Giving feedback" guidance with links to issue, discussion, and chat channels

Co-authored-by: multica-agent <github@multica.ai>
Copilot AI review requested due to automatic review settings May 21, 2026 08:04
@coderabbitai

coderabbitai Bot commented May 21, 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: af2a9185-3f2e-42fd-9417-c40a62b044e7

📥 Commits

Reviewing files that changed from the base of the PR and between f6c1391 and 0892f36.

📒 Files selected for processing (1)
  • v3/README.md
✅ Files skipped from review due to trivial changes (1)
  • v3/README.md

Walkthrough

The v3/README.md file is updated from an Alpha overview to a Beta release announcement. Changes include stability policy references, revised getting-started instructions pointing to v3.wails.io and the wails3 initialization command, a deferred-scope section listing platform and back-end work items, and a dedicated feedback section with links to project resources.

Changes

v3 Beta Release Documentation

Layer / File(s) Summary
Beta release messaging and guidance
v3/README.md
README transitions from Alpha guidance to Beta release messaging: adds "What Beta means" stability statement and v3/STABILITY.md reference, updates getting-started instructions to direct readers to v3.wails.io and wails3 init flow, lists deferred platform and back-end scope, and establishes dedicated feedback channels.

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs:

  • wailsapp/wails#5268: Overlapping updates to v3 getting-started README material and wails3 install/init guidance.
  • wailsapp/wails#5269: Related v3 documentation updates and contributor guidance referencing v3 materials.
  • wailsapp/wails#4597: Related changes touching wails3 installation paths used in release/nightly documentation.

Suggested labels: Documentation, v3-alpha, lgtm

"🐰 A README hops from Alpha to Beta bright,
Stability stated, getting-started in sight,
wails3 init points the new trail,
Deferred platforms noted without fail,
Feedback channels open—hop on and write!"

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: updating the v3 README from Alpha placeholder content to a Beta scope statement.
Description check ✅ Passed The PR description provides clear context, motivation, and specific details about changes, but lacks explicit coverage of testing and several template checklist items.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/beta-release-manager/d785cc4b

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 and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the v3 README to reflect the v3 Beta status and clearly communicate what is (and is not) covered by the beta stability guarantee, along with updated onboarding and feedback links.

Changes:

  • Renames “v3 Alpha” README header to “Wails v3 Beta” and adds a “What Beta means” stability statement.
  • Replaces the old “read mkdocs-website” getting-started text with a docs-site link and wails3 install/init commands.
  • Adds a “Beta scope” deferred-features section and a feedback section with project links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread v3/README.md Outdated
- **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
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 v3/README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with 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.

Inline comments:
In `@v3/README.md`:
- 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.
- Around line 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 ``` to ```bash or
```shell) so the commands in the wails3 install/init snippet render with proper
syntax highlighting.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ea7f08ab-e7db-411e-96c8-8ef170cbfc45

📥 Commits

Reviewing files that changed from the base of the PR and between 2f7c250 and f6c1391.

📒 Files selected for processing (1)
  • v3/README.md

Comment thread v3/README.md Outdated
Comment thread v3/README.md Outdated
@leaanthony

Copy link
Copy Markdown
Member Author

The CI failure in "Run Go Tests v3 (ubuntu-latest, 1.25)" → "Run tests (ubuntu) - GTK4 default" is unrelated to this PR — this change only updates v3/README.md (a markdown file, no Go code). The same test was passing on master on 2026-05-17 and the failure is a regression introduced by commits merged to master between May 17–21, likely related to the GTK4-as-default switch from PR #5463.

The PR itself is clean and mergeable. Could you please review and merge when ready? This README update is the last documentation item needed on master for the beta readiness criteria.

CC @leaanthony

@leaanthony leaanthony merged commit 67ce980 into master Jun 13, 2026
18 of 21 checks passed
@leaanthony leaanthony deleted the agent/beta-release-manager/d785cc4b branch June 13, 2026 23:00
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.

3 participants