-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Closed
Labels
arch-wasmWebAssembly architectureWebAssembly architecturearea-VM-meta-monodocumentationDocumentation bug or enhancement, does not impact product or test codeDocumentation bug or enhancement, does not impact product or test codein-prThere is an active PR which will close this issue when it is mergedThere is an active PR which will close this issue when it is merged
Milestone
Description
Currently, the documentation dealing with building, debugging, testing or other topics related to wasm, is spread across multiple file in docs, and also in various README.md files. This makes finding answers difficult.
We should at least have an index, or a top level document that can link to all the scattered bits, and make it easier to find.
- Add a top level doc for wasm topics intended for users of this repo - for example for building, debugging, testing, benchmarking, running on codespaces etc - we have https://github.com/dotnet/runtime/tree/main/docs#readme that serves as an index
- Add a FAQ section to help with common scenarios like -
How do I debug a library test failure seen on CI? - We have a plenty of places where we write the same instruction, e.g.
https://github.com/dotnet/runtime/blob/4f6698967e25e0e075150623d6a3f5c518806d8b/docs/workflow/debugging/libraries/debugging-vscode.md#debugging-libraries-with-visual-studio-code-running-on-mono
and
https://github.com/dotnet/runtime/blob/4f6698967e25e0e075150623d6a3f5c518806d8b/src/mono/wasi/README.md#4-debug-it
and
https://github.com/dotnet/runtime/blob/4f6698967e25e0e075150623d6a3f5c518806d8b/docs/workflow/testing/libraries/debugging-wasm.md#debug-with-vs-code
are all about debugging WASM by connecting to the port using VS/VS Code. Consolidate it.
Copilot
Metadata
Metadata
Assignees
Labels
arch-wasmWebAssembly architectureWebAssembly architecturearea-VM-meta-monodocumentationDocumentation bug or enhancement, does not impact product or test codeDocumentation bug or enhancement, does not impact product or test codein-prThere is an active PR which will close this issue when it is mergedThere is an active PR which will close this issue when it is merged