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

Document the debugger #298

Closed
ZX-WT opened this issue Nov 8, 2016 · 3 comments
Closed

Document the debugger #298

ZX-WT opened this issue Nov 8, 2016 · 3 comments

Comments

@ZX-WT
Copy link
Contributor

ZX-WT commented Nov 8, 2016

I would like to document the debugger, just realize the debugger is not mentioned in the documentation, but I don't really use the debugger very often, I just started using it sometime ago and that's why I knew that the debugger part is missing. I am surprised that such fundamental feature has been left out for such a long time.

What I plan to do is by simply write a few lines about each section of the debugger,errors, remote inspector, profiler etc. I think that having short documentation about the debugger is better than nothing.

This could be done in a short time(I probably need to learn the syntax again, it was way too long that I committed a doc page), the problem is that I don't know what exactly these tools offer, could anyone offer some help?

@pwab
Copy link

pwab commented Jan 8, 2018

Are you still interested in contributing such a page for the docs? Would be awesome to have an overview of the tools/possibilities when v3 is shipped.

This page could:

  • explain how to work with errors in general (stacktrace and such)
  • show the use of the debugger
  • show the use of the profiler
  • show the use of monitoring
  • show how to remote debug (see Document remote debug #173)
  • explain why there is no exception handling (this could prevent questions like this)
  • explain how to log exceptions (see reference question)

Also related to #368.

@ZX-WT
Copy link
Contributor Author

ZX-WT commented Jan 9, 2018

I would like to work on it but before that I need to understand the new debugger. The showing part should not be a difficult task for me but for the explaining part, I think it is better for a more experienced user to write it.

@mhilbrunner
Copy link
Member

Closing as duplicate of #368 for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants