stricklandrbls commented on code in PR #1331:
URL: https://github.com/apache/daffodil-vscode/pull/1331#discussion_r2285811638


##########
DEVELOPMENT.md:
##########
@@ -371,7 +372,51 @@ The local Apache Daffodilâ„¢ Extension for Visual Studio 
Code downloads and cach
     ```
 
     This will start the debug adapter and await a connection from the Apache 
Daffodil VS Code Extension (usually on TCP port 4711); and
-- debug your schema file, as long as it has the `useExistingServer` setting 
above.
+- debug your schema file, as long as your `launch.json` has the 
`useExistingServer` setting above.
+
+#### Debugging UI Source
+
+##### Inspecting the HTML
+
+To inspect the HTML, open up the UI window (e.g., Configure launch.json, Data 
Editor) that you wish to inspect and open the Webview Developer Tools with 
`Ctrl + Shift + P` and typing `Developer: Open Webview Developer Tools`.
+
+![ui-debug1](https://github.com/user-attachments/assets/77f44956-7536-4e96-b9ec-23b7ffbaecdc)
+
+From the Elements tab, you can inspect the HTML by expanding and hovering 
elements to highlight them in the UI.
+
+![ui-debug2](https://github.com/user-attachments/assets/a3378311-236e-4c54-9e58-ab34286da461)
+
+Likewise, you can use the Inspect tool to click on items in the UI to see the 
corresponding HTML element.
+
+![ui-debug3](https://github.com/user-attachments/assets/a601c5e8-9eff-46a2-9811-c62c16b2fe27)
+
+![ui-debug4](https://github.com/user-attachments/assets/27c407f7-ded2-4780-b8e8-e5d6bb8d1f40)
+
+Note: This only debugs the UI from the DOM. It does not add any debugging 
functionality within the Data Editor's extension source files.

Review Comment:
   A couple of things:
   1. Remove the reference to the Data Editor since the extension UI using this 
debugging technique across. Then link the section that would describe the 
procedures for debugging that extension source (If it exists, I'm not sure)
   2. Move this note to immediately follow the title of this subsection. It is 
easily overlooked in it's currently position.
   
   Personally, what I would put would be as follows:
   
   ##### Inspecting the HTML
   To inspect the HTML, open up the UI window (e.g., Configure launch.json, 
Data Editor) that you wish to inspect and open the Webview Developer Tools with 
`Ctrl + Shift + P` and typing `Developer: Open Webview Developer Tools`.
   > **NOTE:** This only debugs the UI from the DOM. It does not add any 
debugging functionality within the extension's JS/TS source files.
   
   The markdown syntax for this would be:
   ```md
   ##### Inspecting the HTML
   To inspect the HTML, open up the UI window (e.g., Configure launch.json, 
Data Editor) that you wish to inspect and open the Webview Developer Tools with 
`Ctrl + Shift + P` and typing `Developer: Open Webview Developer Tools`.
   
   > **NOTE:** This only debugs the UI from the DOM. It does not add any 
debugging functionality within the extension's JS/TS source files.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to