README.md: Clean up of README sections, link fix
I placed content in the 'what's next' section that was not already
duplicated in the quickstart content. Most of the sections simply
pointed to other docs.
Change-Id: Ife12aa33c243c2078a7223ff045f4441a3ebd4ea
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/428876
Reviewed-by: Jamal Carvalho <jamal@golang.org>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
diff --git a/README.md b/README.md
index 358dfbd..e24c89c 100644
--- a/README.md
+++ b/README.md
@@ -51,14 +51,23 @@
## What's next
-* Explore more [features](#features) of the VS Code Go extension.
-* Learn how to [customize](#customization) your settings.
-* Solve issues with
- [Troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting).
+* Explore more [features][full feature breakdown] of the VS Code Go extension.
+* View the
+ [settings documentation](https://github.com/golang/vscode-go/wiki/settings)
+ and [advanced topics](https://github.com/golang/vscode-go/wiki/advanced) to
+ customize the extension.
+* View the [tools documentation](https://github.com/golang/vscode-go/wiki/tools)
+ for a complete list of tools the VS Code Go extension depends on.
+* Solve issues with the
+ [general troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting)
+ and [debugging troubleshooting](https://github.com/golang/vscode-go/wiki/debugging#troubleshooting)
+ guides.
* [file an issue](https://github.com/golang/vscode-go/issues/new/choose) for
problems with the extension.
* Start a [GitHub discussion](https://github.com/golang/vscode-go/discussions)
or get help on [Stack Overflow].
+* Explore Go language resources on [go.dev/learn](https://go.dev/learn) and
+ [golang.org/help](https://golang.org/help).
If you are new to Go, [this article](https://golang.org/doc/code.html) provides
the overview on Go code organization and basic `go` commands. Watch ["Getting
@@ -104,28 +113,14 @@
"gopls": { "ui.semanticTokens": true }
```
-## Tools
-
-The extension uses a few command-line tools developed by the Go community. In
-particular, `go`, `gopls`, and `dlv` **must** be installed for this extension
-to work correctly. See the [tools documentation](https://github.com/golang/vscode-go/wiki/tools) for a complete
-list of tools the extension depends on.
-
-In order to locate these command-line tools, the extension searches
-`GOPATH/bin` and directories specified in the `PATH` environment variable (or
-`Path` on Windows) with which the VS Code process has started. If the tools are
-not found, the extension will prompt you to install the missing tools and show
-the "⚠️ Analysis Tools Missing" warning in the bottom right corner. Please
-install them by responding to the warning notification, or by manually running
-the [`Go: Install/Update Tools` command].
-
## Setting up your workspace
-[Go modules](https://golang.org/ref/mod) are how Go manages dependencies in
+The VS Code Go extension supports both `GOPATH` and Go modules modes.
+
+[Go modules](https://golang.org/ref/mod) are used to manage dependencies in
recent versions of Go. Modules replace the `GOPATH`-based approach to specifying
which source files are used in a given build, and they are the default build
-mode in go1.16+. While this extension continues to support both Go modules and
-`GOPATH` modes, we highly recommend Go development in module mode. If you are
+mode in go1.16+. We highly recommend Go development in module mode. If you are
working on existing projects, please consider migrating to modules.
Unlike the traditional `GOPATH` mode, module mode does not require the workspace
@@ -135,34 +130,8 @@
Your project may involve one or more modules. If you are working with multiple
modules or uncommon project layouts, you will need to configure your workspace
-by using [Workspace Folders]. Please see this [documentation about supported
-workspace layouts].
-
-## Customization
-
-The extension needs no configuration and should work out of the box. However,
-you may wish to adjust settings to customize its behavior. Please see the
-[settings documentation](https://github.com/golang/vscode-go/wiki/settings) for a comprehensive list of settings.
-See [advanced topics](https://github.com/golang/vscode-go/wiki/advanced) for further customizations and unique
-use cases.
-
-## Troubleshooting
-
-If the extension isn't working as you expect, you can take a look at our
-troubleshooting guides. There is one for [general
-troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting), and another specifically for
-[troubleshooting the debugging feature](https://github.com/golang/vscode-go/wiki/debugging#troubleshooting).
-
-## Ask for help
-
-If the troubleshooting guides did not resolve the issue, please reach out to us
-by [filing an issue](https://github.com/golang/vscode-go/issues/new/choose),
-[starting a GitHub discussion](https://github.com/golang/vscode-go/discussions),
-or by asking a question on [Stack Overflow].
-
-Also, you can take a look at [go.dev/learn](https://go.dev/learn) and
-[golang.org/help](https://golang.org/help) for more general guidance on using
-Go.
+by using [Workspace Folders]. See the
+[Supported workspace layouts documentation] for more information.
## Preview version
@@ -174,9 +143,10 @@
We welcome your contributions and thank you for working to improve the Go
development experience in VS Code. If you would like to help work on the VS Code
-Go extension, please see our [contribution guide](https://github.com/golang/vscode-go/wiki/contributing). It
-explains how to build and run the extension locally, and describes the process
-of sending a contribution.
+Go extension, see our
+[contribution guide](https://github.com/golang/vscode-go/wiki/contributing) to
+learn how to build and run the VS Code Go extension locally and contribute to
+the project.
## Code of Conduct
@@ -204,5 +174,5 @@
[full feature breakdown]: https://github.com/golang/vscode-go/wiki/features
[workspace documentation]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
[`Go: Install/Update Tools` command]: https://github.com/golang/vscode-go/wiki/commands#go-installupdate-tools
-[documentation about supported workspace layouts]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
+[Supported workspace layouts documentation]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
[Workspace Folders]: https://code.visualstudio.com/docs/editor/multi-root-workspaces
