JeremyYao commented on issue #1203: URL: https://github.com/apache/daffodil-vscode/issues/1203#issuecomment-3211834554
Review for https://github.com/apache/daffodil-vscode/wiki/Introduction-to-Daffodil-VS-Code-Extension/643b0833015cb0b3bd354d0f42814cc5152b59b2. ### 1 <img width="1282" height="586" alt="Image" src="https://github.com/user-attachments/assets/e8a45a9f-28b2-4db3-bb43-5a9966dc9bef"; /> This step needs to be revised. Following the previous steps, it should lead you to run the config we created from the earlier steps. See the following step below <img width="1302" height="413" alt="Image" src="https://github.com/user-attachments/assets/123e9e9b-30a9-4fa1-b3ec-1085e178c88e"; /> Revise the step to show the run and debug window containing the name of the config we created from the prior steps. The run and debug window should look like the following: https://code.visualstudio.com/docs/debugtest/debugging#_debugger-user-interface ### 2 <img width="1296" height="638" alt="Image" src="https://github.com/user-attachments/assets/26d0c1ca-84e0-4205-8e65-a72066354814"; /> If you follow the prior steps, the data editor should not be opening. ### 3 <img width="1011" height="445" alt="Image" src="https://github.com/user-attachments/assets/460c8956-2947-460f-8102-70e9086295e1"; /> Non-header text is bold. Unbold it to keep it consistent with prior steps ### 4 <img width="1022" height="325" alt="Image" src="https://github.com/user-attachments/assets/ee102ee2-1523-448e-bb43-97256d92dad2"; /> Rephrase `Run the debug extension, and choose a dfdl schema and data file. Make sure the language mode is DFDL.` to `Run the corresponding debug configuration from prior step`. You can omit `and choose a dfdl schema and data file. Make sure the language mode is DFDL.` part ### 5 <img width="1142" height="524" alt="Image" src="https://github.com/user-attachments/assets/bd4ff1c5-4c8d-4a60-b14d-9df6a75d4b40"; /> Add something in this step to recommend saving the TDML file in the current project folder. (The folder that's currently open in VS Code) ### 6 <img width="1148" height="889" alt="Image" src="https://github.com/user-attachments/assets/ad9e0b34-092f-4667-9e5c-b5a775e49be6"; /> Combine these two steps into one. It should be enough to word the combined steps as `Open the TDML file` ### 7 <img width="1226" height="613" alt="Image" src="https://github.com/user-attachments/assets/ebd49050-c190-465e-9ba0-b5d49e38670f"; /> Verify if this step is valid for the current version of the extension on the Marketplace. https://github.com/apache/daffodil-vscode/pull/1259 was merged in on Jul 7th, which is for 1.4.2. ### Overall comments I observed that some of the steps don't flow well and that parts of the steps still implicitly assume you're debugging the 1.4.2 Snapshot version of the extension (so building and debugging the extension) as a developer. It may help to remove all snapshot versions of the extension from your VS Code as you're adding steps to the guide, install the extension from the Marketplace, retrace the prior steps to saving the launch.json config, and then working through from there. -- 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]
