Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 25, 2025

Summary

This PR reorganizes and streamlines the WebAssembly (Wasm) documentation in the docs/ directory. It consolidates duplicate debugging instructions, introduces a top-level Wasm documentation hub, and improves cross-references between related topics. The documentation is now easier to navigate and is focused on contributor workflows.

Key changes:

  • Created wasm-documentation.md as the main entry point for Wasm topics (build, debug, test, benchmark, Codespaces, etc.).
  • Consolidated all Wasm debugging guides into a single reference.
  • Merged library testing and debugging content.
  • Added FAQ for common Wasm scenarios.
  • Updated links and removed duplicated content.
  • Improved documentation structure and logical flow.
  • Ensured all content is contributor-focused and maintains previous information.
  • Fixed style: Changed WASM to Wasm throughout, removed redundant 'comprehensive' wording, and simplified descriptions.

These improvements make it significantly easier for contributors to find relevant Wasm documentation and follow consistent workflows.

Fixes #81798


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Sep 25, 2025
@ilonatommy ilonatommy added documentation Documentation bug or enhancement, does not impact product or test code arch-wasm WebAssembly architecture and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Sep 26, 2025
@ilonatommy ilonatommy changed the title [WIP] [wasm] Make finding information for wasm in docs/ easier [wasm] Make finding information for wasm in docs/ easier Sep 26, 2025
@ilonatommy ilonatommy requested a review from maraf September 26, 2025 09:37
…plicated stack trace content

Co-authored-by: ilonatommy <[email protected]>
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 addresses the issue of scattered WebAssembly documentation by creating a comprehensive documentation organization system for WASM-related content in the dotnet/runtime repository. The purpose is to make it easier for developers to find information about building, testing, debugging, and working with WebAssembly in the .NET runtime.

Key changes:

  • Created a centralized WebAssembly documentation index with comprehensive cross-references
  • Consolidated debugging instructions into a single reference document
  • Added cross-references from existing WASM documentation to the new centralized resources

Reviewed Changes

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

Show a summary per file
File Description
docs/README.md Added link to new WebAssembly documentation index
docs/workflow/wasm-documentation.md New comprehensive WASM documentation hub with FAQ and cross-references
docs/workflow/debugging/wasm-debugging.md New consolidated debugging reference with VS Code and Chrome DevTools instructions
docs/workflow/debugging/mono/native-wasm-debugging.md Updated to reference consolidated debugging guide
docs/workflow/debugging/libraries/debugging-vscode.md Updated cross-references to new debugging documentation
docs/workflow/testing/libraries/debugging-wasm.md Replaced duplicated content with references to consolidated debugging guide
src/mono/wasi/README.md Removed duplicated debugging instructions, added reference to consolidated guide
src/mono/browser/README.md Added reference to comprehensive WASM documentation
src/mono/wasm/features.md Added reference to comprehensive WASM documentation
src/mono/wasm/threads.md Added reference to comprehensive WASM documentation

@ilonatommy
Copy link
Member

@copilot, fix

Error: docs/workflow/debugging/wasm-debugging.md:40:69 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2]
Error: docs/workflow/debugging/wasm-debugging.md:65:65 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2]
Error: docs/workflow/debugging/wasm-debugging.md:171:76 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2]
Error: docs/workflow/wasm-documentation.md:66:53 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2]

Copilot AI requested a review from ilonatommy October 1, 2025 14:23
Copilot finished work on behalf of ilonatommy October 1, 2025 14:23
@ilonatommy
Copy link
Member

ilonatommy commented Oct 1, 2025

@copilot, your last session failed. Retry

Copilot finished work on behalf of ilonatommy October 1, 2025 15:21
@ilonatommy
Copy link
Member

The CI has probably the same problem as aspnetcore did: dotnet/aspnetcore#62509. Build Analysis expects any job that is green but does not find them and waits for ever. I will add a similar ever-green job for docs-only changes.

@jkotas
Copy link
Member

jkotas commented Oct 7, 2025

The structure looks fine to me. I do not work day-to-day on wasm, so I cannot vouch for factual correctness of the updates.

@pavelsavara @radekdoulik @AaronRobinsonMSFT Could you please review and signoff?

@ilonatommy ilonatommy merged commit 7dcfa87 into main Oct 9, 2025
148 of 154 checks passed
@akoeplinger akoeplinger deleted the copilot/fix-121e53e7-7832-4eab-9851-10b0a7e6bdf3 branch October 11, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

arch-wasm WebAssembly architecture documentation Documentation bug or enhancement, does not impact product or test code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[wasm] Make finding information for wasm in docs/ easier

5 participants