Join GitHub today
GitHub is home to over 28 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 search box within sticky top-bar #27721
There have been some good proposals(#26637 #27714 ) to improve navigate documentation. This proposal is a further supplement.
Compared with #27714, it has one advantage,
Thank you for the proposal @hooluupog.
I think there are two parts to it that are being presented together. Let me talk about them separately.
One part of this proposal that I'm seeing is the UI design and the interactions it presents. As you say, compared to #27714, this has better discoverability. The fact that it lacks a keyboard shortcut is easy to change if desired; a keyboard shortcut that focuses on the box can be added.
The other part is the difference in elements that can be searched from. Proposals #26637 and #27714 have been about searching/navigating within identifiers of the single package whose documentation is being displayed. According to your text and screenshot, this proposal suggests considering including jumping across packages. This is a pretty significant deviation and would need to be described and thought through in more detail.
I think both of the suggestions are good to consider and evaluate in our future work on the godoc UI, and we'll want to do so while also considering the other similar proposals. The end result may combine the best aspects from all of these related proposals. So I think it's "accepted" in the sense we will take this idea into consideration, but it's too early to say what the implementation will end up looking like exactly. It will take building and evaluating some prototypes to gain more insight.
I'm not sure how this state falls into the proposal process. If it interferes with the proposal review meetings, it might make sense to unmark these issues as proposals and treat them as normal issues.