Skip to content

feat: add DocSearch as recommended by pkgdown #3943

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

Merged
merged 1 commit into from
Apr 18, 2020

Conversation

s-pace
Copy link

@s-pace s-pace commented Apr 11, 2020

👋 team,

I am working on DocSearch. We have an integration for pkgdown. We thought it is a shame you can not also used this search.

This PR will add DocSearch to the documentation website. It will allow a user to have a learn-as-you-type experience by displaying results thanks to a dropdown in a live way.

Let me know if you need anything.

@yutannihilation
Copy link
Member

DocSearch was added by #3370 and then removed by #3374. I don't know about the detail, but it seems DocSearch didn't work at that time.

@batpigandme
Do you think this is worth trying again?

@s-pace
Copy link
Author

s-pace commented Apr 11, 2020

It is now working yes

@batpigandme
Copy link
Contributor

Yeah, if it's working, then, sure thing.

@s-pace
Copy link
Author

s-pace commented Apr 11, 2020

@yutannihilation
Copy link
Member

Thanks, so the previous mistake was that we used the same key (tidyverse) over multiple repositories, right? Then, I have no concern.

One more question. Can we use this API key? It seems there are already several API keys used among tidyverse and r-lib repositories, but I don't know how they are managed...

@s-pace
Copy link
Author

s-pace commented Apr 13, 2020

Yes it is one key for a website

@yutannihilation
Copy link
Member

Thanks.

@yutannihilation
Copy link
Member

What I'm still not sure is that which is better to use the API key here or the new one someone in the tidyverse team issues, but I think it's fine to merge this PR anyway as we can replace the key anytime.

I'll wait for some days before merging this. If you have any other concern, please comment.

@yutannihilation yutannihilation merged commit 4b0e01d into tidyverse:master Apr 18, 2020
@yutannihilation
Copy link
Member

Merged. Thanks @s-pace for catching this :)

@s-pace s-pace deleted the patch-1 branch April 18, 2020 19:11
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.

3 participants