Skip to content

Fix: Increase the number of results of the doc search bar #2719

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 2 commits into from
Mar 16, 2023

Conversation

Dedelweiss
Copy link
Contributor

@Dedelweiss Dedelweiss commented Mar 7, 2023

This PR corrects PR #2716 that I made.
In this one I set the search bar value of the blog to 5 as it was before and I set the search bar value of the documentation to 6 with distinct to true.
See the algolia documentation for:

Before:

Screenshot 2023-03-07 at 10 02 42

After:

Screenshot 2023-03-14 at 16 01 03

Also for the idea of having a paging system to be able to see other results. I've just seen that there is an open issue for this for DocSearch.
algolia/docsearch#883

@ckipp01
Copy link
Member

ckipp01 commented Mar 10, 2023

In your after image it shows two exact same Scaladoc results. Are those linking to the same page? Also is that the same page that is listed under Style Guide? Since we'd want to avoid multiple duplicates in the same result.

@Dedelweiss
Copy link
Contributor Author

In your after image it shows two exact same Scaladoc results. Are those linking to the same page? Also is that the same page that is listed under Style Guide? Since we'd want to avoid multiple duplicates in the same result.

So I changed the results to 6 because 7 was a bit too much. I also added the option to not have the same result twice. Also the Scaladoc in the Scaladoc part and the Scaladoc in the Style Guide part are not the same.
Scaladoc part: https://docs.scala-lang.org/scala3/guides/scaladoc/#inner-main
StyleGuide: https://docs.scala-lang.org/style/scaladoc.html#inner-main

@Dedelweiss Dedelweiss changed the title Increase the number of results of the doc search bar WIP: Increase the number of results of the doc search bar Mar 14, 2023
@Dedelweiss Dedelweiss marked this pull request as ready for review March 15, 2023 10:07
@Dedelweiss Dedelweiss changed the title WIP: Increase the number of results of the doc search bar Fix: Increase the number of results of the doc search bar Mar 15, 2023
Copy link
Member

@ckipp01 ckipp01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for digging into this @Dedelweiss. This looks good to me.

LGTM

@ckipp01 ckipp01 requested a review from julienrf March 15, 2023 13:48
@julienrf julienrf merged commit 3ec184c into scala:main Mar 16, 2023
@Dedelweiss Dedelweiss deleted the search branch March 16, 2023 08:41
@SethTisue
Copy link
Member

Thank you Lucas and Chris!

@Dedelweiss
Copy link
Contributor Author

Thank you Lucas and Chris!
Thanks to you. I'll keep in touch with the pagination issue created for DocSearch as it would indeed be interesting to implement it.

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.

4 participants