MicrosoftDocs / edge-developer

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

Change the search scope to narrow down to edge developer #3090

Closed captainbrosset closed 4 months ago

captainbrosset commented 4 months ago

Rendered docs for review:

Changing the search scope to Microsoft Edge Developer would better match our docset, and return fewer, but more useful, results when using the search tool.

This would make the Filter by title box show a more relevant last option:

image

And would hopefully narrow down the results to our docset only. Currently, the results are for Microsoft Edge, and include a lot of non-developer documentation.

My only uncertainty is whether Microsoft Edge Developer is actually a scope that can be used on Learn. Currently, it returns nothing:

image

AB#49334958

learn-build-service-prod[bot] commented 4 months ago

Learn Build status updates of commit 3507d71:

:white_check_mark: Validation status: passed

File Status Preview URL Details
microsoft-edge/docfx.json :white_check_mark:Succeeded

For more details, please refer to the build report.

For any questions, please:

captainbrosset commented 4 months ago

My only uncertainty is whether Microsoft Edge Developer is actually a scope that can be used on Learn. Currently, it returns nothing.

I now understand how this works. You can use new search scopes in docfx.json. The first time a new search scope is introduced it returns nothing, and a few days later, it starts working. So, the idea is to introduce the new search scope while also keeping the old one, so that results are still returned. And after a few days, we can remove the old one if we want.

The order matters too: "searchScope": ["Microsoft Edge Developer", "Microsoft Edge"] means that Microsoft Edge results are returned first, which is good because the newly introduced Microsoft Edge Developer scope won't work just yet. Once it does work, we could either remove Microsoft Edge or reverse the order: "searchScope": ["Microsoft Edge", "Microsoft Edge Developer"]. This way, developer docs results would be returned first, but we'd still have general edge results too, in case no matches are found.

captainbrosset commented 4 months ago

Testing might be hard, I don't think the site search tool works on the preview server.