x/tools/cmd/godoc: show entities before cross-references #21686
Labels
Milestone
Comments
bcmills
added
the
NeedsFix
|
Change https://golang.org/cl/129135 mentions this issue: |
gopherbot
pushed a commit
to golang/tools
that referenced
this issue
Oct 19, 2018
Currently, we generate the TOC for a page dynamically after page load through javascript. This is fine for pages with static content. But for pages with dynamic output like /search, sometimes this causes a noticeable page jump due to extensive DOM traversal. Also, the heuristics to calculate the no. of columns is very rudimentary and fills the entire above-the-fold area if the no. of results is very large. Therefore, we generate the TOC from server side itself. And improve the no. of columns heuristic further to accomodate up to 4 columns. This improves page performance and utilizes real estate appropriately according to the input. Some screenshots at laptop (1366x768) resolution. https://snag.gy/AXz2rP.jpg https://snag.gy/th3Nn8.jpg More can be found in the CL comments. Fixes golang/go#21685 Updates golang/go#21686 Change-Id: Ia9b6dd1e67231d992709e4ba10ebdbedfe38b564 Reviewed-on: https://go-review.googlesource.com/c/129135 Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Bryan C. Mills <bcmills@google.com>
gopherbot
added
the
Tools
henderjon
pushed a commit
to oggodoc/godoc
that referenced
this issue
Jun 13, 2024
Currently, we generate the TOC for a page dynamically after page load through javascript. This is fine for pages with static content. But for pages with dynamic output like /search, sometimes this causes a noticeable page jump due to extensive DOM traversal. Also, the heuristics to calculate the no. of columns is very rudimentary and fills the entire above-the-fold area if the no. of results is very large. Therefore, we generate the TOC from server side itself. And improve the no. of columns heuristic further to accomodate up to 4 columns. This improves page performance and utilizes real estate appropriately according to the input. Some screenshots at laptop (1366x768) resolution. https://snag.gy/AXz2rP.jpg https://snag.gy/th3Nn8.jpg More can be found in the CL comments. Fixes golang/go#21685 Updates golang/go#21686 Change-Id: Ia9b6dd1e67231d992709e4ba10ebdbedfe38b564 Reviewed-on: https://go-review.googlesource.com/c/129135 Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Bryan C. Mills <bcmills@google.com>
|
pkgsite uses a different display layout. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
(A follow-on from #21685.)
Arguably the most useful godoc results are packages, followed by entities defined within those packages (types, variables, functions, interfaces, and methods). Cross-references are sometimes helpful, but rarely what I'm looking for when I'm searching golang.org.
For example, if I search for rand, odds are good I'm looking for the package documentation for either
math/randorcrypto/rand. Unfortunately, at the moment there are so many cross-references that the latter result doesn't even appear above the fold.¹¹
The text was updated successfully, but these errors were encountered: