New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/tools/cmd/godoc: add "jump to identifier" dialog via search box within sticky top-bar #27721

Open
hooluupog opened this Issue Sep 18, 2018 · 2 comments

Comments

Projects
None yet
4 participants
@hooluupog

hooluupog commented Sep 18, 2018

There have been some good proposals(#26637 #27714 ) to improve navigate documentation. This proposal is a further supplement.
Currently, i have to do a lot of scrolling to navigate documentation. Apart from a sidebar and a back-to-top FAB(from #26637), a sticky top-bar with a search box(providing me with suggestions in a drop-down list and let me directly jump to the search result) can be very handy.

Compared with #27714, it has one advantage,

  • Good discoverability (the search box is always visible)

one disadvantage,

  • Lack of keyboard shortcut

one difference,

  • It jumps across packages instead of just jumping to identifier within a package documentation page.
    It looks like this,
    jump

@gopherbot gopherbot added this to the Proposal milestone Sep 18, 2018

@gopherbot gopherbot added the Proposal label Sep 18, 2018

@rsc

This comment has been minimized.

Contributor

rsc commented Oct 3, 2018

/cc @dmitshur

@dmitshur

This comment has been minimized.

Member

dmitshur commented Oct 5, 2018

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.

@dmitshur dmitshur changed the title from proposal: x/tools/cmd/godoc:add "jump to identifier" dialog via search box within sticky top-bar. to proposal: x/tools/cmd/godoc: add "jump to identifier" dialog via search box within sticky top-bar Oct 5, 2018

@rsc rsc changed the title from proposal: x/tools/cmd/godoc: add "jump to identifier" dialog via search box within sticky top-bar to x/tools/cmd/godoc: add "jump to identifier" dialog via search box within sticky top-bar Oct 10, 2018

@rsc rsc modified the milestones: Proposal, Unplanned Oct 10, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment