docs(v3): say what beta means, and stop promising a roadmap that is not there - #5819
Draft
taliesin-ai wants to merge 3 commits into
Draft
docs(v3): say what beta means, and stop promising a roadmap that is not there#5819taliesin-ai wants to merge 3 commits into
taliesin-ai wants to merge 3 commits into
Conversation
…ot there The status page announced "Current Status: Beta" and then said the roadmap "outlines the key features and improvements we need to implement before the final release" without listing any. Someone deciding whether to adopt the beta lands there and leaves with nothing. Two changes: - Say what beta actually commits to. The pieces were already stated, just scattered: the API-stability promise lived in the FAQ and the supported version table lived in SECURITY.md. Consolidated on the status page, split into what is settled and what is still moving, including the parts that are less comfortable (platform coverage is not uniform, pin an exact version). - Replace the roadmap that was not there with live issue-tracker queries. A hand-maintained list of remaining work is stale within a fortnight; three links that are always current are more honest and cost nothing to maintain. Also expands the changelog entry for the promotion so the generated release notes carry the commitment rather than the bare words "alpha to beta". Verified: docs site builds, 1711 pages, all locales. Claude-Session: https://claude.ai/code/session_01FigQqUQbNu9ngE4a2CSNm8
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
github-actions
Bot
added
Documentation
Nothing in the documentation told an existing alpha user how to move onto the beta, and there are a hundred-odd alpha releases' worth of them. The upgrade is genuinely small, but "it is small" is only reassuring once somebody says it. The page that matters most here is the version-pairing note. The CLI will report v3.0.0-beta.0 while @wailsio/runtime still reports 3.0.0-alpha.97, because the npm package is versioned independently. Anyone upgrading will see an "alpha" runtime next to a "beta" CLI and reasonably assume they have a mismatch. Saying so up front costs three sentences; not saying it costs a support thread per confused user. Also covers pinning an exact version rather than tracking latest, regenerating bindings (the most common cause of an upgrade that builds and then misbehaves), and the three things to check when it does go wrong. Verified: docs site builds, 1721 pages, all locales. Claude-Session: https://claude.ai/code/session_01FigQqUQbNu9ngE4a2CSNm8
Follows the lockstep change in #5820: from the beta onwards @wailsio/runtime takes its version from the same file the CLI embeds, so the upgrade page no longer has to explain away a mismatch. It now says the two agree, and why an alpha project's runtime version looks unrelated. Claude-Session: https://claude.ai/code/session_01FigQqUQbNu9ngE4a2CSNm8
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Draft, and based on
releases/v3-beta. Nothing here goes to master and nothing is published.The problem
status.mdxsays "Current Status: Beta", then says the roadmap "outlines the key features and improvements we need to implement before the final release", and then lists none. Someone evaluating the beta lands on that page and leaves with nothing.Meanwhile the actual beta commitments existed but were scattered: the API-stability promise was in the FAQ, and the supported-version table was in SECURITY.md. Neither is where someone asking "is this safe to adopt?" looks.
Changes
Verification
Why draft
Per the plan: English documentation gets completed and reviewed first, and translation only starts once the English is settled. Marking this draft so the wording can be argued with before eight locales inherit it.