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`.
This commit is contained in:
Derek Parker
2016-02-19 10:32:24 -08:00
parent 460f0c910c
commit 63a660820e
24 changed files with 872 additions and 408 deletions

10
scripts/gen-usage-docs.go Normal file
View File

@ -0,0 +1,10 @@
package main
import (
"github.com/derekparker/delve/cmd/dlv/cmds"
"github.com/spf13/cobra/doc"
)
func main() {
doc.GenMarkdownTree(cmds.New(), "./Documentation/usage")
}