Skip to content
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

Improve structure of 'Debugging' chapter #450

Closed
weinand opened this issue Jul 4, 2016 · 6 comments
Closed

Improve structure of 'Debugging' chapter #450

weinand opened this issue Jul 4, 2016 · 6 comments
Assignees
Labels
debug important Issue identified as high-priority
Milestone

Comments

@weinand
Copy link
Contributor

weinand commented Jul 4, 2016

In addition to adding some missing pieces I suggest the following more logical structure of the 'Debugging' chapter:

  • Launch Configurations
    • 'setting up' especially important since new users will come for that
  • Debug and Run
  • Debug Actions
    • stepping (new: optional step back)
    • continue
    • restart
    • stop
  • Current Location
    • Editor: arrow, current line (yellow and green)
    • Call stack: stop reason, stack frames, paging, multiple threads
  • Breakpoints
    • Editor margin
    • breakpoints view: regular, functional, conditional
    • breakpoint actions
  • Data inspection:
    • Variables view:
      • scopes
      • new: type hover
      • setting variable values
    • hovers
    • Watches
  • Debug Console
    • data structure snap shots

@isidorn please correct and add more missing pieces

@isidorn
Copy link
Contributor

isidorn commented Jul 5, 2016

@weinand I modified your comment with some of the missing pieces (threads, types of breakpoints, breakpoint actions) and added some minor comments

@gregvanl gregvanl added this to the backlog milestone Jul 5, 2016
@gregvanl gregvanl modified the milestones: August 2016, backlog Aug 6, 2016
@gregvanl gregvanl modified the milestones: September 2016, August 2016 Sep 5, 2016
@gregvanl gregvanl modified the milestones: October 2016, September 2016 Oct 3, 2016
@isidorn
Copy link
Contributor

isidorn commented Oct 11, 2016

@weinand @gregvanl it would be absolutetly awesome if we did this in October, since the newly generated launch.json will point to http://code.visualstudio.com/docs/editor/debugging#_launch-configurations

So this documentation needs to be as awesome as possible so new user easily figure out what they need to set in order to have a smoooth debugging experience

@isidorn
Copy link
Contributor

isidorn commented Oct 27, 2016

@gregvanl has there been some progress on this? I think this is a key point in making the initial debug experience smoother

ping @weinand @chrisdias @waderyan

@gregvanl
Copy link

@isidorn Yes, you can track the progress in the vscode-docs vnext branch https://github.com/Microsoft/vscode-docs/blob/vnext/docs/editor/debugging.md
I've done some reordering, updated to the new leaner launch.json and added descriptions for the required attributes.
Next is to fill out the variables substitution section and add more attribute descriptions.
The outline above is fairly exhaustive for all the debugging features, both those that are easily discoverable through the UI (for example : current location, stop reason, stack frame) and more advanced (multi-threaded, conditional breakpoints). The tricky bit is tuning the initial sections for the first time user (the goal for this milestone) without overwhelming them.

@gregvanl
Copy link

gregvanl commented Nov 2, 2016

Still more work to be done here around variables view and advanced debugging like multithreaded. Moving to November.

@gregvanl gregvanl modified the milestones: November 2016, October 2016 Nov 2, 2016
@weinand weinand mentioned this issue Dec 13, 2016
18 tasks
@gregvanl
Copy link

Covered in December doc-a-thon with debugging.md and node-debugging.md refresh. #729

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
debug important Issue identified as high-priority
Projects
None yet
Development

No branches or pull requests

3 participants