mtp

I took a brief stab at something that's bothered me with https://pkg.go.dev: how poorly promoted examples are in package documentation.

Do you think this is worth proposing in a FR?

The main difference is promoting examples as a top-level index item as opposed to being nested somewhat opaquely in the body on the right. Being embedded remains, but the left-hand navigation bar surfaces examples much more readily.

Go Packages - Go Packages

Go is an open source programming language that makes it easy to build simple, reliable, and efficient software.

May 15 at 7:47pmWeb
Show threadmtpMay 16
Proposed in https://go-review.googlesource.com/c/pkgsite/+/673435.
Show threadmtpJun 2
Please register your thoughts in: https://github.com/golang/go/issues/73951.
x/pkgsite: promote examples as a top-level TOC item and populate with children · Issue #73951 · golang/go

What is the URL of the page with the issue? https://pkg.go.dev/sort What is your user agent? Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Sa...

GitHub
Show threadMiek GiebenMay 15
@matt YES!
Show threadRay LeeMay 15
@matt This would be lovely. Usually when I’m in there I’m hunting for examples first, and have wanted an index to them for years.