Skip to content

docs(readme): clarify install for v2 vs v3 alpha#5268

Merged
leaanthony merged 2 commits into
masterfrom
docs/readme-v2-v3
Apr 29, 2026
Merged

docs(readme): clarify install for v2 vs v3 alpha#5268
leaanthony merged 2 commits into
masterfrom
docs/readme-v2-v3

Conversation

@leaanthony

@leaanthony leaanthony commented Apr 29, 2026

Copy link
Copy Markdown
Member

Summary

Adds a small two-row table under "Getting Started" so readers can see at a glance which version of Wails they want — v2 stable, or v3 alpha — and copy the appropriate go install line.

Everything else (badges, sponsors image, JetBrains, FAQ, contributors, license, inspiration) is unchanged.

Test plan

  • Render the README on github.com/wailsapp/wails and confirm the table looks right.
  • Confirm the sponsors image still renders.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated "Getting Started" section with version information, installation commands, and documentation links for Wails v2 and v3 in a clear table format.

Adds a small two-row table under "Getting Started" so readers can see
at a glance which version they want to install: v2 (stable) for
production use, or v3 (alpha) for the next-generation build. The rest
of the README — sponsors image, badges, FAQ, etc. — is unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 29, 2026 11:31
@coderabbitai

coderabbitai Bot commented Apr 29, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@leaanthony has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 18 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f730bf20-2469-4933-be4b-07a4ed7030b8

📥 Commits

Reviewing files that changed from the base of the PR and between bea26e8 and c99e43d.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

README.md updated to replace a single external-link Getting Started instruction with a comprehensive two-version overview. A table now displays Wails v2 and v3 installation details, status, and documentation links, with a retained link to full installation instructions.

Changes

Cohort / File(s) Summary
Documentation
README.md
"Getting Started" section restructured from single external link to version/status/install command/docs table covering Wails v2 and v3.

Suggested labels

Documentation, v3-alpha, size:XS

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A table now blooms where one link once stood,
Two Wails versions shine, as they should,
v2 and v3 in rows align,
Making installation clear and fine! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides a clear summary of changes and test plan, but does not follow the required template with sections like Type of change, Testing details, or required checklists. Fill out the PR template including Type of change, How Has This Been Tested, Test Configuration, and complete the checklist items to align with repository standards.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding clarification for installation between Wails v2 and v3 alpha in the README.
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 docs/readme-v2-v3

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
Review rate limit: 0/8 reviews remaining, refill in 2 minutes and 18 seconds.

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

@github-actions github-actions Bot added the Documentation Improvements or additions to documentation label Apr 29, 2026

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

Adds quick-install guidance in the root README so new users can choose between Wails v2 (stable) and v3 (alpha) at a glance.

Changes:

  • Introduces a small table under “Getting Started” listing v2 vs v3 status, install command, and docs link
  • Replaces the single installation-link sentence with the table + a follow-up link to full installation instructions

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

Comment thread README.md
| Version | Status | Install | Docs |
|---|---|---|---|
| v2 | Stable | `go install github.com/wailsapp/wails/v2/cmd/wails@latest` | [wails.io](https://wails.io/) |
| v3 | Alpha | `go install github.com/wailsapp/wails/v3/cmd/wails3@latest` | [v3.wails.io](https://v3.wails.io/) |

Copilot AI Apr 29, 2026

Copy link

Choose a reason for hiding this comment

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

The v3 install command points to github.com/wailsapp/wails/v3/cmd/wails3@latest, but this repository doesn’t contain a v3/cmd tree (currently v3/ only has scripts). As written, go install will fail for readers. Please update the v3 row to use the actual install path/version for the v3 CLI (as published), or replace the install cell with a link to the v3 installation docs instead of an unverified go install command.

Suggested change
| v3 | Alpha | `go install github.com/wailsapp/wails/v3/cmd/wails3@latest` | [v3.wails.io](https://v3.wails.io/) |
| v3 | Alpha | [See v3 installation docs](https://v3.wails.io/getting-started/installation/) | [v3.wails.io](https://v3.wails.io/) |

Copilot uses AI. Check for mistakes.
Comment thread README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@leaanthony leaanthony merged commit b4c14dc into master Apr 29, 2026
17 of 18 checks passed
@leaanthony leaanthony mentioned this pull request Apr 29, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants