- 
                Notifications
    You must be signed in to change notification settings 
- Fork 5.2k
          [wasm] Make finding information for wasm in docs/ easier
          #120096
        
          New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
  
    [wasm] Make finding information for wasm in docs/ easier
  
  #120096
              Conversation
…ing reference Co-authored-by: ilonatommy <[email protected]>
Co-authored-by: ilonatommy <[email protected]>
…ntent Co-authored-by: ilonatommy <[email protected]>
docs/ easierdocs/ easier
      …plicated stack trace content Co-authored-by: ilonatommy <[email protected]>
There was a problem hiding this 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 | 
| @copilot, fix Error: docs/workflow/debugging/wasm-debugging.md:40:69 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2] | 
Co-authored-by: Jan Kotas <[email protected]>
| @copilot, your last session failed. Retry | 
| The CI has probably the same problem as aspnetcore did: dotnet/aspnetcore#62509.  | 
| 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? | 
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:
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.