Document the protocal between the debug adapter and the debugger core

Open
#401 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp
Domain
devtools, documentation

Research direction

Start by locating the debug adapter and debugger core interfaces, then inventory the functions exchanged between them. Document each function's purpose and whether it is synchronous or asynchronous, with the protocol boundaries clearly identified. Done means the adapter-core protocol is described comprehensively; no files or tests are named in the issue.

Written by the indexing model from the issue text.

Description

documentation Impact: Low

We should document what each function does and whether they are synchronous/asynchronous, etc.

Related to #370

Dominant language
C++
Stars
331
Forks
33
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Vector35/debugger

All issues in Vector35/debugger

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.