Skip to content
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

Add feature search links #2865

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Add feature search links #2865

merged 2 commits into from
Feb 22, 2024

Conversation

kennykerr
Copy link
Collaborator

@kennykerr kennykerr commented Feb 21, 2024

Still need to add support for versioned links, but this is basic idea.

Fixes: #2717

@kennykerr
Copy link
Collaborator Author

@ChrisDenton @tim-weis This is the feature search support that @riverar has been working on. Here's a preview:

https://microsoft.github.io/windows-rs/features/

Do let us know what you think. This is the final piece I'd like to wrap up before releasing 0.53 (#2854).

@ChrisDenton
Copy link
Collaborator

ChrisDenton commented Feb 21, 2024

The functionality works great for me for the types I've tried. Only minor issue is that on mobile the website is just slightly too wide for my phone. Maybe the version selection box could drop below or above the input on narrow screens?

A possible future enhancement would be to have some way to input a list of types and get a unified list of features rather than entering them one at a time. But I think that's one for the suggestion box and not something that needs thinking about now.

@kennykerr
Copy link
Collaborator Author

We could scrap the drop down if the target is configurable via the URL.

@riverar
Copy link
Collaborator

riverar commented Feb 22, 2024

Adjusted the branch drop-down so it wraps on mobile. Still more work to be done here (e.g. perhaps we shift into a two-inner-row per row layout) but something we can address a bit later.

image

@kennykerr kennykerr merged commit 3396244 into master Feb 22, 2024
66 checks passed
@kennykerr kennykerr deleted the feature-links branch February 22, 2024 02:38
@tim-weis
Copy link
Contributor

That looks like a workable solution.

The only suggestion I have is to add a "Copy to clipboard" button. That's not something that needs immediate attention, and could be incorporated at a later time.

@tim-weis
Copy link
Contributor

Well, maybe I lied. A cup of coffee later I was reminded about a few more suggestions I had in mind:

  • Provide a link to the Rust documentation. I don't know how feasible that is, but it would be convenient to have a quick way to navigate to the signature/type information.
  • Provide a link to the MSDN reference documentation. That would need a bit of work but it would be very handy to have.
  • Improve the relevance priority in searches. As an example, typing createprocess into the search field has the CreateProcessW API listed way down. Prioritizing exact (prefix) matches might work better.

I don't know how others feel about those suggestions, but they would definitely streamline my workflow.

At any rate, thank you for putting this together and reminding me that a browser-based search doesn't have to stall the browser window.

@riverar
Copy link
Collaborator

riverar commented Feb 22, 2024

All great suggestions, will def. work on those.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation no longer lists required features
4 participants