search

microsoft / debug-adapter-protocol

Defines a common protocol for debug adapters.
https://microsoft.github.io/debug-adapter-protocol/
Other
1.44k stars 131 forks source link

clarify debug session launch sequence #499

Closed connor4312 closed 2 months ago

connor4312 commented 2 months ago

Closes #497

As referenced in that issue, the flow diagram for starting a debug session was not super clear and was very implicit about the constraints previously discussed in https://github.com/microsoft/vscode/issues/4902#issuecomment-368583522

This attempts to refine that with a better diagram and textual description.

I also added a small script to build the diagrams, and to ensure they displayed well I added a devcontainer setup and updated Jekyll as necessary (the very old version we were on no longer built on modern Ruby versions.)

int19h commented 2 months ago

I would suggest also renaming the diagram files from .txt to .mmd to clearly indicate that it is Mermaid, and also so that GitHub can preview them directly in the repo.

tromey commented 2 months ago

FWIW I've read the new text and I think it clears things up very well. Thank you.