chore: review debugging section PR (#6807)

ChainSafe · May 22, 2024 · 3c5bb15 · 3c5bb15
1 parent 992fdd4
commit 3c5bb15
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/.vscode/README.md b/.vscode/README.md
@@ -1,2 +1,3 @@
-Adapt to your needs `launch.template.json` and copy as `launch.json`.
-Follow `docs/pages/tools/debugging.md` for more details.
+Copy `launch.template.json` as `launch.json` and adapt to your needs.
+
+See [Debugging](../docs/pages/tools/debugging.md) for more details.
diff --git a/.vscode/launch.template.json b/.vscode/launch.template.json
@@ -76,4 +76,4 @@
       "description": "Enter the test name to run, leave empty to run all"
     }
   ]
-}
+}
diff --git a/docs/pages/tools/debugging.md b/docs/pages/tools/debugging.md
@@ -1,10 +1,15 @@
----
-title: Debugging
----
+# Debugging
+
+This page describes different approaches for debugging Lodestar.
+
+## VS Code launch config
+
+The simplest way to debug is to use the provided [launch.template.json](https://github.com/ChainSafe/lodestar/blob/unstable/.vscode/launch.template.json) `configurations`. Copy them as `.vscode/launch.json` and they will be made available in the `Run and Debug` section in VS Code. Adapt as needed, e.g. by adding additional arguments to the beacon [configuration](https://github.com/ChainSafe/lodestar/blob/unstable/.vscode/launch.template.json#L22) to match your needs.
 
-The simplest way to debug is to use the provided [launch.template.json](https://github.com/ChainSafe/lodestar/blob/unstable/.vscode/launch.template.json) `configurations`. Adapt and copy them as `.vscode/launch.json`, and they will be made available in the `Run and Debug` section. Note that users probably want to adapt the arguments of the beacon [configuration](https://github.com/ChainSafe/lodestar/blob/unstable/.vscode/launch.json#L11) to match their needs.
 VS Code supports debugging Workers out of the box when using those configurations.
 
+## Attach to running process
+
 Remote `lodestar` processes can also be debugged by leveraging [node:inspector](https://nodejs.org/api/inspector.html). Adding `--inspect` to the node CLI (e.g. `NODE_OPTIONS=--inspect ./lodestar beacon`) allows to debug the main thread. To debug a specific `Worker`, follow those steps:
 
 - remove `--inspect` from `node` CLI