[WebGPU plugin EP] Update release and packaging-related docs#29059
Open
edgchen1 wants to merge 3 commits into
Open
[WebGPU plugin EP] Update release and packaging-related docs#29059edgchen1 wants to merge 3 commits into
edgchen1 wants to merge 3 commits into
Conversation
Fix the top-level README's outdated 'How it fits together' bullets (no ORT-Nightly publication happens; outputs are pipeline artifacts), and clarify that publishing to public feeds is handled by separate release pipelines. Expand the bundled wheel and nupkg READMEs with Installation, Supported Platforms (incl. Windows DXC bundling and Linux Vulkan loader notes), and Troubleshooting sections that quote the actual version-mismatch error string from the plugin EP loader. Align developer-facing READMEs (csharp/, python/): consistent pipeline-link style; cross-build constraint moved next to build instructions; CI Pipeline section dropped from csharp/README.md to match python/README.md; pack_nuget.py --artifacts-dir flow documented. Also fix stale comment in plugin-webgpu-nuget-packaging-stage.yml (stage no longer runs a test) and align the RC versioning TODO in plugin-webgpu-packaging-stage.yml with the semver-dotted convention used in RELEASE.md. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Restructure the 'Release workflow' section into three clearly numbered phases (Prepare release branch / Build and validate packages / Release) with real Markdown numbered lists for the sub-steps, and add 'Step 1/2/3' prefixes to the H3 headings so cross-references are unambiguous. Reorder Step 2 so fix integration happens before the packaging pipeline run, avoiding a redundant initial run on a patch branch that has only been version-bumped. Emphasize the nuget.org publish-by-accident risk on the test-publishing step with a bold caution callout, add a worked example for the next-dev-version bump, and tighten back-references in Step 3. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
guschmue
previously approved these changes
Jun 16, 2026
Align the Python and C# package READMEs around a user-focused structure and wording: matching top-level descriptions, consistent Linux Vulkan-loader prerequisite/troubleshooting guidance, and aligned troubleshooting remediation style. Simplify Supported Platforms to platform/RID support lists (remove native binary filename implementation details, including DXC DLL mentions) to reduce maintenance drift and keep the docs focused on end-user decisions. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
guschmue
approved these changes
Jun 17, 2026
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.
Description
WebGPU plugin EP doc updates:
Motivation and Context
Improve docs.