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

New doc search issues #8321

Closed
essen opened this issue Mar 28, 2024 · 3 comments
Closed

New doc search issues #8321

essen opened this issue Mar 28, 2024 · 3 comments
Labels
bug Issue is reported as a bug

Comments

@essen
Copy link
Contributor

essen commented Mar 28, 2024

Describe the bug
The doc search is sub-optimal with the new docs.

There used to be Algolia (https://www.erlang.org/doc/search?q=ssl) which could be quite powerful to navigate the entirety of the documentation. Now it only provides links that are served by HexDocs.

The HexDocs search does not let us navigate the entirety of the documentation however.

If I am on https://www.erlang.org/docs/27/apps/ssl/ssl# and search for "design" I get this: https://www.erlang.org/docs/27/apps/ssl/search.html?q=design

In order to find the design principles documentation I need to first click on the Erlang logo, which gets me to https://www.erlang.org/docs/27/readme.html and then searching for "design" I get https://www.erlang.org/docs/27/search.html?q=design which gives me what I looked for: https://www.erlang.org/docs/27/system/design_principles.html

It seems that the HexDocs search is not just one search but many searches depending on your location. From my point of view however, I am trying to search the OTP docs in their entirety, not a specific application (at least by default). So they do not do their work correctly.

Worse, going back to Algolia results (https://www.erlang.org/doc/search?q=ssl), by searching for "ssl" I could reach https://www.erlang.org/docs/27/apps/ssl/ssl_crl_cache# immediately. Today, if I search for "ssl" I only get the ssl application, and "ssl_crl_cache" (https://www.erlang.org/docs/27/search.html?q=ssl_crl_cache) gives me nothing. So it appears that for me to reach the documentation for the ssl_crl_cache I need to perform two searches or click my way through. This is sub-optimal as this completely breaks the shortcut I have in my browser's address bar.

Expected behavior
It was working before, don't fix it!

@essen essen added the bug Issue is reported as a bug label Mar 28, 2024
@dumbbell
Copy link
Contributor

I also greatly miss the Algolia inline search. Like @essen, I heavily depended on that to move around the docs to find a module or a function, regardless of the application it belongs to, or to find the Type Specification or the OTP Design Principales guides, and so on. The new search seems limited to the application I'm browsing, not the entire Erlang/OTP docs, which is a huge regression.

Also, the default behavior when using the new inline search is to perform a full text search. It used to be that pressing Enter would go to the first result. Most of the time, this was exactly what I was looking for. Now, I need to use arrows to select the first result.

@dumbbell
Copy link
Contributor

Another regression I just noticed with the search: the first results are clearly not the ones I would expect.

For instance I'm reading the gen_server doc and search for start_link. Now, the first results are from peer and slave, the ones from the latter being event deprecated (and stroke through in the search results).

20240328_123452

Is it because I read the peer docs a few minutes earlier and it tracks that? I hope not.

@garazdawi
Copy link
Contributor

I have prepared algolia to be used with the new docs, I just haven't enabled it yet for the release candidates. It will be a bit different, but should offer the same functionality as we have now.

In the long run we hope that the ex_doc/hexdocs team will finish their search solution so that we can use that as it should be better than what we have today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue is reported as a bug
Projects
None yet
Development

No branches or pull requests

3 participants