gopls/doc: clean up and slightly reorganize documentation

This is a first CL to clean up the gopls documentation. The main changes
are cosmetic (to correct warnings found by the MD Lint VS Code
extension), though some parts are reworded or moved around. Ultimately,
more work needs to be done, particularly on the user guide and features

My current thinking is that we should rename to
configuration and move the configuration piece out of the user guide,
and also reorganize the user guide to be more "getting started"

I'm still not sure where miscellaneous items should go (e.g., working on
the Go distribution itself)--I deleted the FAQ because it seemed useless
and is probably not the most discoverable, but it's the only place that
comes to mind so far.

Change-Id: I3689362067672f7ad8d5e8fd97ca9c7c45cfc8c4
Trust: Rebecca Stambler <>
Run-TryBot: Rebecca Stambler <>
Reviewed-by: Robert Findley <>
16 files changed
tree: 80b5604f31c792afe85ea263754beb70f8a9cb43
  1. .gitattributes
  2. .gitignore
  3. .prettierrc
  10. benchmark/
  11. blog/
  12. cmd/
  13. codereview.cfg
  14. container/
  15. copyright/
  16. cover/
  17. go.mod
  18. go.sum
  19. go/
  20. godoc/
  21. gopls/
  22. imports/
  23. internal/
  24. playground/
  25. present/
  26. refactor/
  27. txtar/

Go Tools


This subrepository holds the source for various packages and tools that support the Go programming language.

Some of the tools, godoc and vet for example, are included in binary Go distributions.

Others, including the Go guru and the test coverage tool, can be fetched with go get.

Packages include a type-checker for Go and an implementation of the Static Single Assignment form (SSA) representation for Go programs.


The easiest way to install is to run go get -u You can also manually git clone the repository to $GOPATH/src/

JS/CSS Formatting

This repository uses prettier to format JS and CSS files.

The version of prettier used is 1.18.2.

It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see

The main issue tracker for the tools repository is located at Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.