search

MicrosoftDocs / edge-developer

Developer documentation for Edge.
https://learn.microsoft.com/microsoft-edge/developer/
Creative Commons Attribution 4.0 International
381 stars 505 forks source link

Search UX improvements #3051

Closed pankajparashar closed 5 months ago

pankajparashar commented 7 months ago

Link to the documentation page: https://learn.microsoft.com/en-us/search/

Description of the issue: The Search experience on the Docs site is a bit meh. For example,

  1. There is no option to narrow the search scope within Microsoft Edge DevTools. The closest option is Microsoft Edge which yields more results, so have to manually look at the URL path to find out which one belongs to DevTools.
  2. Clicking on the links on the search result, takes you to the start of the page, and not the section which has the text that was shown in the search result. So again, have to manually jump to that section using Find in Page. image
  3. Eventually I did find what I was looking for on Page 5 of the search results (this link). It could have been a bit faster if there was an option to do pt1. Since all I could remember was the term "screenshot" but didn't remember what that option in the context menu was actually called.
  4. Links belonging to DevTools docs have an odd title, "Microsoft Edge Development" instead of more familiarly named "Microsoft Edge DevTools". This could make easier to filter results that belong to DevTools instead of visually parsing the URL path below the title. image
captainbrosset commented 6 months ago

Thanks for filing this Pankaj. Let me bring this back to the team for discussions. For info, though, note that our documentation website on learn.microsoft.com is not just for DevTools. Our table of content shows that we document DevTools, PWAs, platform, webview2, extensions, test automation, and more. Basically everything that has to do with Edge for web developers. This explains some of the confusion you've experienced.

captainbrosset commented 6 months ago

For information, we've not forgotten about this issue @pankajparashar. Michael has already made a change to the suffix displayed on the results page. It's now Microsoft Edge Developer documentation. We can't make it more specific than this, and only about DevTools, because, as said previously, our docset contains documentation for DevTools, PWAs, platform, WebView2, extensions, test automation, etc. But hopefully this change is already a little improvement.

I've started thinking about your first point too, and I'm experimenting with restricting search results to just our docset, instead of the entire Edge docs. Although this won't restrict them to just DevTools, it should be much better than today.

pankajparashar commented 6 months ago

Great work! guys. I can already feel a remarkable difference in the Search UX. Sorry for a bit of rant in the opening remark, I certainly appreciate the work done, understand the constraints and am very positive that this is headed in the right direction.

image

captainbrosset commented 5 months ago

3051 should be the final step needed to close this issue. It won't solve your feedback about search results containing more than just devtools, but we can't solve this feedback without splitting the devtools docs into their own docset, which we're not planning on doing at this point.

mikehoffms commented 5 months ago

3051 should be the final step needed to close this issue. It won't solve your feedback about search results containing more than just devtools, but we can't solve this feedback without splitting the devtools docs into their own docset, which we're not planning on doing at this point.

probably meant PR #3097 should be the final step to close this issue (Issue #3051)