[tools] gopls/doc: use YAML title blocks in .md files

0 views

Skip to first unread message

Alan Donovan (Gerrit)

unread,

Jul 8, 2025, 12:45:00 PMJul 8

to goph...@pubsubhelper.golang.org, golang-...@googlegroups.com, Go LUCI, Robert Findley, golang-co...@googlegroups.com

Alan Donovan submitted the change with unreviewed changes

Unreviewed changes

1 is the latest approved patch-set.
The change was submitted with unreviewed changes in the following files:

```
The name of the file: gopls/doc/design/implementation.md
Insertions: 1, Deletions: 1.

@@ -1,5 +1,5 @@
 ---
-title: "Gopls: implementation"
+title: "Gopls: Implementation"
 ---
 
 Last major update: Jan 16 2024
```
```
The name of the file: gopls/doc/index.md
Insertions: 2, Deletions: 2.

@@ -169,8 +169,8 @@
 `gopls` currently only supports the `go` command, so if you are using
 a different build system, `gopls` will not work well. Bazel is not officially
 supported, but may be made to work with an appropriately configured
-`go/packages` driver. See
-[bazelbuild/rules_go#512](https://github.com/bazelbuild/rules_go/issues/512)
+[go/packages driver](https://pkg.go.dev/golang.org/x/tools/go/packages#hdr-The_driver_protocol).
+See [bazelbuild/rules_go#512](https://github.com/bazelbuild/rules_go/issues/512)
 for more information.
 You can follow [these instructions](https://github.com/bazelbuild/rules_go/wiki/Editor-setup)
 to configure your `gopls` to work with Bazel.
```

Change information

Commit message:

gopls/doc: use YAML title blocks in .md files

These are honored both by GFM and x/website (the latter
now being our canonical dialect), and set the <title>
element as well as the h1. The actual headings should
start at h2 (##).

Also, replace @user GFM syntax with explicit links to
https://github.com/user.

Change-Id: I0d65f659a2215ee8aec73352867f64eebf8f4a78

Reviewed-on: https://go-review.googlesource.com/c/tools/+/686335

LUCI-TryBot-Result: Go LUCI <golang...@luci-project-accounts.iam.gserviceaccount.com>

Reviewed-by: Robert Findley <rfin...@google.com>

Files: