-
Notifications
You must be signed in to change notification settings - Fork 17
add docs for JS debugger in language docs #165
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
base: main
Are you sure you want to change the base?
Conversation
content/v3/javascript-components.md
Outdated
|
|
||
| #### Setup | ||
|
|
||
| First, make sure that the extension is installed. Next verify that the templates are new enough to support debugging. This can be verified by looking `.vscode/setting.json` and verifying if something like the following is configured: |
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.
Maybe split this into "installing the extension" (once) and "setting up the project" (each project).
content/v3/javascript-components.md
Outdated
|
|
||
|  | ||
|
|
||
| **Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge. |
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.
| **Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge. | |
| **Note:** The debugger currently does not follow sourcemaps for NPM dependencies, as some packages do not bundle the source code in the package. |
content/v3/javascript-components.md
Outdated
|
|
||
| **Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge. | ||
|
|
||
| ## Caveats |
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.
I am not sure but it feels like this has come adrift from the stuff about APIs and packages that it more naturally lives with perhaps?
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.
I do not follow this. Can you elaborate please?
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.
The "Caveats" section feels like it's talking primarily about APIs and packages. But it is now separated from the APIs and packages stuff by a long section about debugging - someone reading about the programming model will likely not check all the way to the bottom of the page to see it. So I am wondering if the debugging stuff should come after Caveats rather than before it?
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.
Ah got it. Moved the section above.
|
@karthik2804 Is this still on your radar? Sorry, I realise travel has thrown things out. |
|
@itowlson I will get to this today. |
4b39d7c to
701fe98
Compare
Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com> small fixes based on suggestions Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>
701fe98 to
f9c2093
Compare
Adds docs for using the StarlingMonkey debugger with the JavaScript SDK for Spin.