add docs for JS debugger in language docs by karthik2804 · Pull Request #165 · spinframework/spin-docs

karthik2804 · 2026-01-16T09:39:49Z

Adds docs for using the StarlingMonkey debugger with the JavaScript SDK for Spin.

content/v3/javascript-components.md

itowlson · 2026-01-19T19:23:34Z

content/v3/javascript-components.md

+
+#### 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:


Maybe split this into "installing the extension" (once) and "setting up the project" (each project).

content/v3/javascript-components.md

itowlson · 2026-01-19T19:33:32Z

content/v3/javascript-components.md

+
+![JS debugger running](/static/image/docs/js-debugger-running.png)
+
+**Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge. 


Suggested change

**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.

itowlson · 2026-01-19T19:37:19Z

content/v3/javascript-components.md

+
+**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


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?

I do not follow this. Can you elaborate please?

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?

Ah got it. Moved the section above.

itowlson · 2026-02-03T01:55:59Z

@karthik2804 Is this still on your radar? Sorry, I realise travel has thrown things out.

karthik2804 · 2026-02-03T09:12:46Z

@itowlson I will get to this today.

karthik2804 · 2026-02-19T08:46:58Z

This should now be ready for review.

itowlson

Mostly grammar/voice nitpicks but I do think we should reorganise the headings. The current structure is very very deep, but also very narrow (e.g. there is only one H3, so it's not grouping anything). Most of the rest is looking for consistency of voice. But the content looks fine.

itowlson · 2026-02-22T19:36:26Z

content/v3/javascript-components.md

+
+#### Setup
+
+##### Installing the Extension


Heading level 5?!?!?! Let's reassess the structure here. Maybe

## Debugging in VS Code ### Debugger Status ### Installing the Debugger ### Setting up a Project for Debugging ### Running a Project in the Debugger

(I don't feel that the "debugger is a work in progress" para needs to be a separate heading, this is just to retain the way you have it. For myself, I would make that note part of the front matter.)

content/v3/javascript-components.md

itowlson · 2026-02-22T19:49:04Z

content/v3/javascript-components.md

+
+![JS debugger running](/static/image/docs/js-debugger-running.png)
+
+**Note:** The debugger currently does not follow sourcemaps for NPM dependencies, as some packages do not bundle the source code in the package. 


What is the significance of this? Should we explain it in terms of what they can and cannot do, or will JS devs understand implicitly what this means for them?

I have updated this to be more clear now. Let me know what you think.

Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com> small fixes based on suggestions Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

Co-authored-by: itowlson <github@hestia.cc> Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

itowlson

Looks good - thank you!

Issues have been addressed but user has not been able to re-review

karthik2804 requested review from itowlson and tschneidereit January 16, 2026 09:39

mikkelhegn previously requested changes Jan 16, 2026

View reviewed changes

content/v3/javascript-components.md Show resolved Hide resolved

content/v3/javascript-components.md Outdated Show resolved Hide resolved

content/v3/javascript-components.md Outdated Show resolved Hide resolved

content/v3/javascript-components.md Outdated Show resolved Hide resolved

radu-matei approved these changes Jan 19, 2026

View reviewed changes

itowlson requested changes Jan 19, 2026

View reviewed changes

karthik2804 requested review from itowlson and mikkelhegn February 3, 2026 10:09

karthik2804 force-pushed the add_js_debugger_docs branch 3 times, most recently from 701fe98 to f9c2093 Compare February 5, 2026 13:45

itowlson requested changes Feb 22, 2026

View reviewed changes

karthik2804 force-pushed the add_js_debugger_docs branch from c7e0a03 to 42e82e4 Compare February 23, 2026 07:21

karthik2804 and others added 3 commits February 23, 2026 10:03

add docs for JS debugger in language docs

06b5608

Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com> small fixes based on suggestions Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

Apply suggestions from code review

d4127b3

Co-authored-by: itowlson <github@hestia.cc> Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

rework heading levels and clarify note about sourcemap following

97e624c

Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

karthik2804 force-pushed the add_js_debugger_docs branch from 42e82e4 to 97e624c Compare February 23, 2026 09:03

itowlson approved these changes Feb 23, 2026

View reviewed changes

itowlson merged commit a2d292e into spinframework:main Feb 23, 2026
3 checks passed


		#### 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:


		![JS debugger running](/static/image/docs/js-debugger-running.png)

		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: 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.


		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

Conversation

karthik2804 commented Jan 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

itowlson commented Feb 3, 2026

Uh oh!

karthik2804 commented Feb 3, 2026

Uh oh!

karthik2804 commented Feb 19, 2026

Uh oh!

itowlson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

itowlson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants