Skip to content

docs: declare the public API stable and prepare for 1.0.0 - #20

Merged
andresvillenas merged 1 commit into
mainfrom
docs/prepare-1-0-0-stable
Sep 15, 2026
Merged

andresvillenas merged 1 commit into
mainfrom
docs/prepare-1-0-0-stable

Conversation

@andresvillenas

Copy link
Copy Markdown
Collaborator

Summary

  • Replaces README's "APIs and behavior may change before the first stable release" with an explicit stability statement — the release validation in docs/Compatibility.md is complete and the minimum-version commitment has been confirmed.
  • Updates every stale beta.4/beta.5 version reference to 1.0.0: README's version matrix and install command, Usage-Guide.md's install command, and Release-Process.md's "next planned release" line and example tag commands.
  • Removes Directory.Build.props's VersionSuffix so a local dotnet pack produces 1.0.0 instead of a beta-labeled artifact. Confirmed this builds and packs cleanly. The release workflow (release.yml) already derives the published version from the git tag via -p:PackageVersion, so this only affects local/dev builds and documentation — not what has already shipped.
  • Corrects README's stale "build-verified through 31.7.2" to 31.8.4 to match the current Compatibility.md record.

Not included, intentionally: tagging and publishing v1.0.0 itself. Those are separate, higher-stakes actions (an immutable NuGet publish) left for a deliberate follow-up once you're ready to pull that trigger.

Test plan

  • dotnet build clean (0 errors).
  • dotnet test — 90/90 pass.
  • dotnet pack locally confirmed to produce XperienceCommunity.FormsToolkit.1.0.0.nupkg (no beta suffix).

Replaces README's "APIs and behavior may change before the first stable
release" with an explicit stability statement, now that the full release
validation (docs/Compatibility.md) is complete and the minimum-version
commitment has been confirmed.

Updates every stale beta.4/beta.5 version reference (README's version
matrix and install command, Usage-Guide's install command,
Release-Process's "next planned release" and example tag commands) to
target 1.0.0, and removes Directory.Build.props's VersionSuffix so a
local dotnet pack no longer produces a beta-labeled artifact. The release
workflow itself already derives the published version from the git tag,
so this only affects local/dev builds and documentation, not what
previously shipped.

Also corrects README's "build-verified through 31.7.2" to 31.8.4 to match
the current Compatibility.md record.

Tagging and publishing v1.0.0 itself are separate, deliberate follow-up
actions, not part of this change.
@andresvillenas
andresvillenas merged commit 2263f05 into main Sep 15, 2026
3 checks passed
@andresvillenas
andresvillenas deleted the docs/prepare-1-0-0-stable branch September 15, 2026 21:04
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.

1 participant