delve/Documentation/internal/README.md

# Internal Documentation

[Architecture of Delve slides](https://speakerdeck.com/aarzilli/internal-architecture-of-delve).

TODO(derekparker)

This directory will hold documentation around the internals of the debugger and how it works.
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 18:32:24 +00:00			`# Internal Documentation`

Documentation: better documentation menu, add guide to writing a client * Adds some links to the more relevant documentation pages on the main README.md * Adds a document informally describing how to write a client of delve * Adds link to slides describing the architecture of delve 2018-06-28 07:42:00 +00:00			`[Architecture of Delve slides](https://speakerdeck.com/aarzilli/internal-architecture-of-delve).`

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 18:32:24 +00:00			`TODO(derekparker)`

			`This directory will hold documentation around the internals of the debugger and how it works.`