Skip to content

Add streamlined CoreCLR WebAssembly documentation with essential build and debug workflows#119104

Merged
AaronRobinsonMSFT merged 11 commits intomainfrom
copilot/fix-a6cf036d-78cb-4dd0-ab7e-ded31276babc
Aug 28, 2025
Merged

Add streamlined CoreCLR WebAssembly documentation with essential build and debug workflows#119104
AaronRobinsonMSFT merged 11 commits intomainfrom
copilot/fix-a6cf036d-78cb-4dd0-ab7e-ded31276babc

Conversation

Copy link
Contributor

Copilot AI commented Aug 26, 2025

This PR adds focused documentation for building, running, and debugging CoreCLR on WebAssembly, addressing the workflow needs outlined in issue #119002.

Changes

New Documentation: docs/workflow/building/coreclr/wasm.md

Added a streamlined guide covering:

  • Cross-platform build instructions for Linux/macOS and Windows using ./build.sh/build.cmd with -os browser target and clr.runtime subset
  • Essential testing approaches:
    • Browser testing with dotnet-serve (recommended)
    • Console testing with Node.js for direct execution
  • Debugging workflows:
    • Chrome DevTools with C/C++ DevTools Support (DWARF) extension
    • VS Code debugging with both WebAssembly Dwarf Debugging extension and Node.js debugging

Updated Main README: docs/workflow/building/coreclr/README.md

Added a new "Platform-Specific Guides" section linking to the WebAssembly documentation, making it discoverable alongside existing platform guides.

Implementation Details

The documentation focuses on the core workflow needed to get started with CoreCLR WebAssembly development:

  • Simplified build commands using only the essential clr.runtime subset
  • Streamlined testing with dotnet-serve for browser scenarios
  • Node.js console execution for direct debugging
  • Updated extension links for both Chrome and VS Code debugging tools

This provides developers with the essential information needed to start working with the experimental CoreCLR WebAssembly support, from initial setup through debugging scenarios.

Fixes #119002


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits August 26, 2025 16:22
Co-authored-by: lewing <24063+lewing@users.noreply.github.com>
…ments

Co-authored-by: lewing <24063+lewing@users.noreply.github.com>
Copilot AI changed the title [WIP] Add wasm CoreCLR workflow documentation (build, test, debug, state, and next steps) Add CoreCLR WebAssembly documentation with build, test, and debug workflows Aug 26, 2025
Copilot AI requested a review from lewing August 26, 2025 16:26
Copy link
Member

@AaronRobinsonMSFT AaronRobinsonMSFT left a comment

Choose a reason for hiding this comment

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

@copilot Please apply review feedback.

…ection, and fix extension links

Co-authored-by: AaronRobinsonMSFT <30635565+AaronRobinsonMSFT@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Aug 26, 2025

@copilot Please apply review feedback.

Applied all review feedback in commit ec5981f. Updated build commands, removed manual testing section and development sections as requested, and fixed both extension links.

Copilot AI changed the title Add CoreCLR WebAssembly documentation with build, test, and debug workflows Add streamlined CoreCLR WebAssembly documentation with essential build and debug workflows Aug 26, 2025
Co-authored-by: AaronRobinsonMSFT <30635565+AaronRobinsonMSFT@users.noreply.github.com>
@AaronRobinsonMSFT AaronRobinsonMSFT marked this pull request as ready for review August 26, 2025 18:56
Copilot AI review requested due to automatic review settings August 26, 2025 18:56

This comment was marked as outdated.

AaronRobinsonMSFT and others added 2 commits August 26, 2025 15:53
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@AaronRobinsonMSFT
Copy link
Member

/cc @pavelsavara

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces comprehensive documentation for building, running, and debugging CoreCLR on WebAssembly, addressing the experimental WASM support workflow needs. The documentation provides developers with essential instructions from initial setup through advanced debugging scenarios.

Key Changes:

  • Added complete WebAssembly build and debug workflow documentation
  • Enhanced discoverability by linking the new guide from the main CoreCLR README
  • Included both browser and console testing approaches with debugging support

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/workflow/building/coreclr/wasm.md New comprehensive guide covering WebAssembly build commands, testing approaches, and debugging workflows for CoreCLR
docs/workflow/building/coreclr/README.md Added "Platform-Specific Guides" section with link to the new WebAssembly documentation

@AaronRobinsonMSFT
Copy link
Member

/ba-g Helix isn't needed for markdown changes.

@AaronRobinsonMSFT AaronRobinsonMSFT merged commit a67ac9b into main Aug 28, 2025
15 of 16 checks passed
@AaronRobinsonMSFT AaronRobinsonMSFT deleted the copilot/fix-a6cf036d-78cb-4dd0-ab7e-ded31276babc branch August 28, 2025 15:50
@github-actions github-actions bot locked and limited conversation to collaborators Sep 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[wasm coreclr] workflow and near future work

5 participants