godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

Search is broken on branches such as `stable`

Open davidak opened this issue 1 year ago • 21 comments

Issue description:

I don't get any results when using the search.

Screenshot from 2024-10-08 15 09 01

URL to the documentation page: e.g. https://docs.godotengine.org/en/stable/search.html?q=export&check_keywords=yes&area=default#

It works for the docs of version:

  • latest
  • 4.1
  • 3.6
  • 3.4
  • 3.3
  • 3.2
  • 2.1

e.g. https://docs.godotengine.org/en/3.6/search.html?q=export&check_keywords=yes&area=default# works

I have tested the docs for every version in the default language (en). The german (de) docs all work.

Reproducible in all tested browsers:

  • Google Chrome 128.0.6613.137
  • epiphany-46.1 (aka GNOME Web, with elementary patches)

davidak avatar Oct 08 '24 13:10 davidak

doesn't work on Firefox 130.0.1 (64-bit) either.

Yarwin avatar Oct 08 '24 13:10 Yarwin

Doesn't work on macos/chrome either

Sundwell avatar Oct 08 '24 13:10 Sundwell

Clear your cache/cookies for the site. Fixed it for me.

Supergeek avatar Oct 08 '24 17:10 Supergeek

Clear your cache/cookies for the site. Fixed it for me.

This did not fix the issue for me. I am on Safari. I think it's an issue with the site/API itself since the problem appears on a variety of browsers.

The issue does not appear when downloading the offline version (10/08/2024) of the documentation.

rishitkhare avatar Oct 09 '24 00:10 rishitkhare

Clear your cache/cookies for the site. Fixed it for me.

This did not fix the issue for me. I am on Safari. I think it's an issue with the site/API itself since the problem appears on a variety of browsers.

The issue does not appear when downloading the offline version (10/08/2024) of the documentation.

The offline version shows me the title where it was found, but didn't the search results show more infos?

TAGames avatar Oct 09 '24 08:10 TAGames

Doesn't work on zen-browser 1.0.1-a.7 (firefox 130.0) and chromium (129.0.6668.100) under linux Clearing cache/cookies didn't solve the problem. Chromium is a fresh install.

dannroda avatar Oct 09 '24 17:10 dannroda

Clear your cache/cookies for the site. Fixed it for me.

This did not fix the issue for me. I am on Safari. I think it's an issue with the site/API itself since the problem appears on a variety of browsers. The issue does not appear when downloading the offline version (10/08/2024) of the documentation.

The offline version shows me the title where it was found, but didn't the search results show more infos?

This also happened to me, I just forgot to mention it.

rishitkhare avatar Oct 09 '24 20:10 rishitkhare

Yes. Seach doesn't yield any results in the stable version of the documentation at the moment. I'm using Chrome on MacOs and Windows 11.

Search seems to be working on latest (not stable) version of the docs though.

botteu avatar Oct 10 '24 08:10 botteu

Clear your cache/cookies for the site. Fixed it for me.

This did not fix the issue for me. I am on Safari. I think it's an issue with the site/API itself since the problem appears on a variety of browsers. The issue does not appear when downloading the offline version (10/08/2024) of the documentation.

The offline version shows me the title where it was found, but didn't the search results show more infos?

If you run a local webserver, then search will display more info than just the title. You should be able to use something like Python's http.server module. I'm using darkhttpd on Termux on Android. Hope that helps until the stable docs search function works again!

Yes. Seach doesn't yield any results in the stable version of the documentation at the moment. I'm using Chrome on MacOs and Windows 11.

Search seems to be working on latest (not stable) version of the docs though.

I'm seeing this as well. Search works on latest but not stable. Tested with Firefox Beta on Android and Firefox on Windows 10.

mifuyne avatar Oct 10 '24 16:10 mifuyne

The search is not working on the Brave Browser either. Version 1.70.126 Chromium: 129.0.6668.100 (Official Build) (64-bit)

And clearing my cache did not resolve the issue.

mmailloux22 avatar Oct 11 '24 00:10 mmailloux22

Yes. Seach doesn't yield any results in the stable version of the documentation at the moment. I'm using Chrome on MacOs and Windows 11.

Search seems to be working on latest (not stable) version of the docs though.

Yes, latest works for me too. Thx, good to know!

TAGames avatar Oct 11 '24 10:10 TAGames

A good friend noticed, that the search triggered by the "other" input field works.

Here is an screenshot from the docs.

Screenshot_20241013-131500964 (1)

The regular search inside the side menu does not work, but the one on the "bottom"

bloemer avatar Oct 13 '24 11:10 bloemer

Can anyone affected by this issue reproduce this in a private browsing tab on a fresh browser profile (or at least with all add-ons disabled)? If you can still reproduce it this way, try reproducing this on a different device on the same network.

Also check the Network tab of DevTools (open it by pressing F12 or Ctrl + Shift + I before starting the search). See if you can find any requests that end with an error there (highlighted in red). If so, please post a screenshot of the request chain.

I'm asking since I can't reproduce this on /en/stable/ with Cromite 129 on Android 14.

Calinou avatar Oct 15 '24 08:10 Calinou

I had this issue on Saturday but I can't reproduce it anymore.

anniryynanen avatar Oct 15 '24 08:10 anniryynanen

I can not reproduce this issue on my mobile with chrome Android 14, But search is broken on my windows pc for stable branch and i cannot find any errors in console either.

As @bloemer mentioned, it works when i search using floating ReadTheDocs Button

syntaxerror247 avatar Oct 15 '24 08:10 syntaxerror247

I had this issue on Saturday but I can't reproduce it anymore.

Same. Today it works.

TAGames avatar Oct 15 '24 09:10 TAGames

Search is still broken on Firefox Beta 132.0b6 (Build #2016049583) on Android, in both regular and private tab.

I'm not at my PC, but I'll update this comment when I get a chance to test it later today.

Edit: stable branch search does not work on the following:

  • Firefox Beta 132.0b6 (Build #2016049583) on Android (regular and private tabs)
  • Firefox 131.0.3 - Windows (regular and private tabs)
  • ungoogled-chromium 129.0.6668.100 - Windows (regular and incognito tabs)

Currently, 4.3 branch search does work in all the aforementioned browsers (thanks for pointing that out, @dannroda!)

mifuyne avatar Oct 15 '24 14:10 mifuyne

For me now works in any version BUT stable. Its odd that it works by using 4.3 and not stable.

dannroda avatar Oct 15 '24 15:10 dannroda

Thanks everyone for reporting and providing details (please keep doing so if you are affected, and also if the issue disappears for you!). We're still investigating and this continues to be hard to pin down (i.e., for me search works on all branches, in various browsers, both desktop and mobile).

mhilbrunner avatar Oct 16 '24 04:10 mhilbrunner

I just checked and it is now working for me 🎉. It seems like ReadTheDocs is updated because its floating button looks different now.

syntaxerror247 avatar Oct 16 '24 07:10 syntaxerror247

The search bar (in the top left) has not worked in the past few days for me. As noted by @bloemer, the search bar within the 'Read the Docs' floating menu does work.

I've tried Firefox v131.0.3 and Chrome v129.0.6668.101 - both don't work for me.

I looked in the Networking tab of the dev tools after a hard reload and there are no errors shown i.e. no content is missed or blocked.


I tried the docs for branch 4.1 and that has a working search function.

SweatyTryhardx10 avatar Oct 16 '24 12:10 SweatyTryhardx10

I'm experiencing the same problems posted in this issue.

Is the search page driven completely by the code in this repository, or does it use a third-party service?

If it only uses the code in this repository, were any relevant changes made shortly before this issue was opened?

daveTheOldCoder avatar Oct 21 '24 15:10 daveTheOldCoder

This issue seemed to be resolved for the last couple of weeks but it seems to have returned in the last ~~~1 hour.~~ [1] I tried searching for "Node" on the stable version of the docs and got no results in a completely fresh Firefox profile. Browser version: 131.0.3 (64-bit)

edit: just checked my browser history and I misremembered, my last successful search was at 11:30am AEDT / 0030UTC That was about 30 minutes before the last RTD build, but that appears to be only for the latest version of the docs (which works) so I have no idea if it is related.

Jack-023 avatar Oct 22 '24 03:10 Jack-023

Is the search page driven completely by the code in this repository, or does it use a third-party service?

The search is provided by ReadTheDocs, not us.

mhilbrunner avatar Oct 24 '24 10:10 mhilbrunner

The search is provided by ReadTheDocs, not us.

Interestingly, on their page – Read the docs – when I'm "using" the search bar inside the menu on the left hand side, it opens up the same pop up, as if I would click on the search input field inside the floating search button.

Looks like a workaround, or new standard. Maybe an outdated version of the CMS?

bloemer avatar Oct 24 '24 11:10 bloemer

I discover this amidst gamejams so please understand when I say I don't have time to do the testing I wish I did. >_<

Search worked normally on /stable/ on both an auto-updated and presumably up to date Firefox running just ublock origin as well as mildly out of date Librewolf running ublock origin and various other things during LD56.

Search stopped working normally on /stable/ on all permutations I've tried on fully updated versions of Firefox and Librewolf regardless of things being turned on or off, cookies and data being cleared, etc. I never fully cleared all data or cookies, but I couldn't find anything obvious left (ie things from godot or read the docs).

Currently, search works perfectly on /4.3/ as well as offline docs.

A friend using Firefox has 0 issues with any kind of searching.

Ruruie-FGSC avatar Oct 26 '24 15:10 Ruruie-FGSC

Hello everyone 👋 Thanks again for all of your feedback.

  1. Can anyone still reproduce this on the stable version of the docs?
  2. Can anyone still reproduce this on the latest version of the docs?

We just did some updates on latest, and RTD may also have improved things on their side, so knowing whether any of that helped would be useful.

mhilbrunner avatar Nov 03 '24 23:11 mhilbrunner

stable version - Search works normally.

latest version - When I type in the search box in the left pane, a popup appears for typing in the search string and displaying the search results. That works, except that the text I type is invisible, which makes it difficult to use. Maybe the dark system theme I'm using is causing the text to be invisible?

daveTheOldCoder avatar Nov 03 '24 23:11 daveTheOldCoder

That works, except that the text I type is invisible

Yeah, it is white text on a white background, I can reproduce that. Seems there is some CSS issue with the RTD search.css, not sure if thats on their end. Will investigate.

mhilbrunner avatar Nov 04 '24 00:11 mhilbrunner

latestand stable now works perfectly for me

dannroda avatar Nov 04 '24 02:11 dannroda