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

OpenSearch for standard library docs #1596

Open
niklasmohrin opened this issue Oct 7, 2021 · 0 comments
Open

OpenSearch for standard library docs #1596

niklasmohrin opened this issue Oct 7, 2021 · 0 comments
Labels
C-Enhancement A new feature or request

Comments

@niklasmohrin
Copy link

Summary

Add OpenSearch description file for the standard library documentation. This means serving a new XML file and possibly introducing a new <link> in the documentation html.

Motivation

I would like to add the standard library docs as a search engine in my browser. This would allow for quick access to the docs with a custom search prefix in all modern browsers without having to install an extra plugin from the store.

Drawbacks

Extra configuration for the new file route would be needed. For an automatic detection of the search configuration, a <link> should be added to the html. This would differentiate the docs html at https://doc.rust-lang.org/std/index.html from what cargo doc would generate.

Rationale and alternatives

Maintenance

I don't know. To me it seems that this doesn't need frequent attention, but I might be totally wrong.

Unresolved Questions

None so far.


In any case, thank you all for your work and time :)

@niklasmohrin niklasmohrin added the C-Enhancement A new feature or request label Oct 7, 2021
@niklasmohrin niklasmohrin changed the title OpenSearch for stdandard library docs OpenSearch for standard library docs Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Enhancement A new feature or request
Projects
None yet
Development

No branches or pull requests

2 participants
@niklasmohrin and others