Skip to content

Commit c41fb17

Browse files
fatoboisthyangah
authored andcommitted
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 <[email protected]> Reviewed-by: Hyang-Ah Hana Kim <[email protected]>
1 parent 4298b52 commit c41fb17

File tree

1 file changed

+24
-54
lines changed

1 file changed

+24
-54
lines changed

README.md

Lines changed: 24 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,23 @@ You are ready to Go :-) &nbsp;&nbsp; 🎉🎉🎉
5151

5252
## What's next
5353

54-
* Explore more [features](#features) of the VS Code Go extension.
55-
* Learn how to [customize](#customization) your settings.
56-
* Solve issues with
57-
[Troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting).
54+
* Explore more [features][full feature breakdown] of the VS Code Go extension.
55+
* View the
56+
[settings documentation](https://github.com/golang/vscode-go/wiki/settings)
57+
and [advanced topics](https://github.com/golang/vscode-go/wiki/advanced) to
58+
customize the extension.
59+
* View the [tools documentation](https://github.com/golang/vscode-go/wiki/tools)
60+
for a complete list of tools the VS Code Go extension depends on.
61+
* Solve issues with the
62+
[general troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting)
63+
and [debugging troubleshooting](https://github.com/golang/vscode-go/wiki/debugging#troubleshooting)
64+
guides.
5865
* [file an issue](https://github.com/golang/vscode-go/issues/new/choose) for
5966
problems with the extension.
6067
* Start a [GitHub discussion](https://github.com/golang/vscode-go/discussions)
6168
or get help on [Stack Overflow].
69+
* Explore Go language resources on [go.dev/learn](https://go.dev/learn) and
70+
[golang.org/help](https://golang.org/help).
6271

6372
If you are new to Go, [this article](https://golang.org/doc/code.html) provides
6473
the overview on Go code organization and basic `go` commands. Watch ["Getting
@@ -104,28 +113,14 @@ by turning on [Gopls' `ui.semanticTokens` setting](https://github.com/golang/vsc
104113
"gopls": { "ui.semanticTokens": true }
105114
```
106115

107-
## Tools
108-
109-
The extension uses a few command-line tools developed by the Go community. In
110-
particular, `go`, `gopls`, and `dlv` **must** be installed for this extension
111-
to work correctly. See the [tools documentation](https://github.com/golang/vscode-go/wiki/tools) for a complete
112-
list of tools the extension depends on.
113-
114-
In order to locate these command-line tools, the extension searches
115-
`GOPATH/bin` and directories specified in the `PATH` environment variable (or
116-
`Path` on Windows) with which the VS Code process has started. If the tools are
117-
not found, the extension will prompt you to install the missing tools and show
118-
the "⚠️ Analysis Tools Missing" warning in the bottom right corner. Please
119-
install them by responding to the warning notification, or by manually running
120-
the [`Go: Install/Update Tools` command].
121-
122116
## Setting up your workspace
123117

124-
[Go modules](https://golang.org/ref/mod) are how Go manages dependencies in
118+
The VS Code Go extension supports both `GOPATH` and Go modules modes.
119+
120+
[Go modules](https://golang.org/ref/mod) are used to manage dependencies in
125121
recent versions of Go. Modules replace the `GOPATH`-based approach to specifying
126122
which source files are used in a given build, and they are the default build
127-
mode in go1.16+. While this extension continues to support both Go modules and
128-
`GOPATH` modes, we highly recommend Go development in module mode. If you are
123+
mode in go1.16+. We highly recommend Go development in module mode. If you are
129124
working on existing projects, please consider migrating to modules.
130125

131126
Unlike the traditional `GOPATH` mode, module mode does not require the workspace
@@ -135,34 +130,8 @@ tree's root directory.
135130

136131
Your project may involve one or more modules. If you are working with multiple
137132
modules or uncommon project layouts, you will need to configure your workspace
138-
by using [Workspace Folders]. Please see this [documentation about supported
139-
workspace layouts].
140-
141-
## Customization
142-
143-
The extension needs no configuration and should work out of the box. However,
144-
you may wish to adjust settings to customize its behavior. Please see the
145-
[settings documentation](https://github.com/golang/vscode-go/wiki/settings) for a comprehensive list of settings.
146-
See [advanced topics](https://github.com/golang/vscode-go/wiki/advanced) for further customizations and unique
147-
use cases.
148-
149-
## Troubleshooting
150-
151-
If the extension isn't working as you expect, you can take a look at our
152-
troubleshooting guides. There is one for [general
153-
troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting), and another specifically for
154-
[troubleshooting the debugging feature](https://github.com/golang/vscode-go/wiki/debugging#troubleshooting).
155-
156-
## Ask for help
157-
158-
If the troubleshooting guides did not resolve the issue, please reach out to us
159-
by [filing an issue](https://github.com/golang/vscode-go/issues/new/choose),
160-
[starting a GitHub discussion](https://github.com/golang/vscode-go/discussions),
161-
or by asking a question on [Stack Overflow].
162-
163-
Also, you can take a look at [go.dev/learn](https://go.dev/learn) and
164-
[golang.org/help](https://golang.org/help) for more general guidance on using
165-
Go.
133+
by using [Workspace Folders]. See the
134+
[Supported workspace layouts documentation] for more information.
166135

167136
## Preview version
168137

@@ -174,9 +143,10 @@ nightly build of this extension. Learn how to install it in by reading the
174143

175144
We welcome your contributions and thank you for working to improve the Go
176145
development experience in VS Code. If you would like to help work on the VS Code
177-
Go extension, please see our [contribution guide](https://github.com/golang/vscode-go/wiki/contributing). It
178-
explains how to build and run the extension locally, and describes the process
179-
of sending a contribution.
146+
Go extension, see our
147+
[contribution guide](https://github.com/golang/vscode-go/wiki/contributing) to
148+
learn how to build and run the VS Code Go extension locally and contribute to
149+
the project.
180150

181151
## Code of Conduct
182152

@@ -204,5 +174,5 @@ conduct-related issue, please mail [email protected].
204174
[full feature breakdown]: https://github.com/golang/vscode-go/wiki/features
205175
[workspace documentation]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
206176
[`Go: Install/Update Tools` command]: https://github.com/golang/vscode-go/wiki/commands#go-installupdate-tools
207-
[documentation about supported workspace layouts]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
177+
[Supported workspace layouts documentation]: https://github.com/golang/tools/blob/master/gopls/doc/workspace.md
208178
[Workspace Folders]: https://code.visualstudio.com/docs/editor/multi-root-workspaces

0 commit comments

Comments
 (0)