Commit Graph

3 Commits

Author SHA1 Message Date
polinasok
7afe640773
Documentation: add DAP API page (#2856)
* Documentation: add DAP API page

* Respond to review feedback

* Clarify about Ctrl-C

* Add hidden TODO for more things to document

Co-authored-by: Polina Sokolova <polinasok@users.noreply.github.com>
2022-01-06 08:58:08 -08:00
Alessandro Arzilli
f7cb6053d2 documentation: API documentation improvements (#507)
* documentation: headless invocation should specify --api-version=2

* documentation: More API documentation

* documentation: copied documentation from client.go to rpc2/server.go

Fixes #164
2016-04-24 10:18:02 -07:00
Derek Parker
63a660820e docs: Move wiki docs into Documentation dir
Going forward, all documentation should be placed in the Documentation
directory in the root of the project. This switch allows maintainers to
approve updates to documentation before they are committed, as opposed
to the pre-existing wiki which anybody could modify.

Currently the Documentation directory includes docs on building, usage,
and minimal docs around the API. This is just the initial commit, and
documentation will continue to improve over time.

Some changes have been made (and will continue to be made) to `cmd/dlv` to
ensure we can auto-generate documentation for all commands from the
newly provided script `scripts/gen-usage-docs.go`, which can be invoked
via `go run scripts/gen-usage-docs.go`.

Additionally, version has been split into its own package. This was a
bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 10:47:46 -08:00