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

Fix: Increase the number of search results #2716

Merged
merged 1 commit into from Mar 6, 2023
Merged

Conversation

Dedelweiss
Copy link
Contributor

As the Scala documentation grows (the new Scala3 version, earlier versions, etc.) the search areas become more diverse, and a search should be as comprehensive as possible so that even the most novice user can easily find what they are looking for.
This is why in this PR, I have increased the number of search results.

Fixes #2715

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.

Ah good find! I didn't even realize we were hitting up on the limit. By changing this does it mean that no matter what 7 items will always be shown, or only when there are more that 5 matching?

@ckipp01 ckipp01 marked this pull request as ready for review March 6, 2023 09:53
@Dedelweiss
Copy link
Contributor Author

I think it is only when more than 5 elements are match.
Screenshot 2023-03-06 at 11 03 39

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.

Ok I'm cool with this, but let's get a couple more opinions.

Copy link
Contributor

@julienrf julienrf left a comment

Choose a reason for hiding this comment

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

I also agree with this change. It would be good to also have a way to see the complete list of results. Is that possible?

@Dedelweiss
Copy link
Contributor Author

So maybe I'm wrong but I tested locally and nothing changes when I change this value. Is it the fact that it is local, or do I have to use the algolia API key. I don't know but I'll look into it.

@SethTisue
Copy link
Member

Let's optimistically merge and see what happens.

@SethTisue SethTisue merged commit 704ab6f into scala:main Mar 6, 2023
@Dedelweiss
Copy link
Contributor Author

Dedelweiss commented Mar 6, 2023

So, I have just made some corrections and research. Is it possible to reopen this pull request or should I create a new one?
I'm also looking into adding pagination, but I've just seen that there is an open issue for this for docsearch.
algolia/docsearch#883

@SethTisue
Copy link
Member

PRs cannot be reopened. Followup PRs are in this area are welcome.

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.

Search functionality seems to be missing things
4 participants