Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
x/tools/cmd/godoc: add "jump to identifier" dialog via F keyboard shortcut, like on godoc.org #27714
https://godoc.org has a "jump to identifier" dialog that can be brought up via the F keyboard shortcut on any package documentation page. It looks like this:
I find it immensely useful for rapidly navigating documentation of Go packages, and most people who know about it seem to find it very useful too. Its largest downfall is the poor discoverability, with many people not knowing that the F keyboard shortcut exists, and this is something that can be improved.
In order to bring more uniformity to the various godoc web UIs and the experiences they offer, I propose we backport this functionality so that it's available within x/tools/cmd/godoc as well.
This is related to #26637 in that it's a mechanism that addresses the same problem of poor navigation within a package, albeit in a different way.
Here's a 24-second video to demonstrate the workflow and navigation speed possible with the "jump to identifier" dialog. In the video, I open the docs for
Note there are no false positives that would be happen if I tried to rely on the browser's search functionality, which is susceptible to finding mentions of an identifier within doc strings of other identifiers.