algolia / algolia/sphinx-docsearch

Breaking: Frontend UI poof bug

Open
#60 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
21
Forks
1
Avg merge
2d 5h
Merged PRs (30d)
4

Description

The UI doesn't load in, so search doesn't work (null err from `docsearch.js`).

I tried to debug it, but the file is _uglified_, so it's too difficult to debug (keep an eye out for a feat request to un-uglify these so we can help you guys debug).

More context, screenshots, and [very dirty] workarounds in the [Docsearch Discord thread](https://discord.com/channels/1171089640443367494/1326435893447233618)

**TL;DR:**

1. ![image](https://github.com/user-attachments/assets/d6c085f6-fd30-45e7-ba28-4e49b2970879)

2. This prevents generating the HTML code:

```html








Ctrl+K




```

The ultra-dirty workaround is to copy+paste this into `source/_templates/layout.html` to inject this directly in instead of awaiting generation. The other js containing the api keys and such still spawn np.

Contributor guide

Open the contributing guide

Research direction

Start by examining the uglified `docsearch.js` referenced in the report and the generated search markup around `source/_templates/layout.html`. Reproduce the null error and compare it with the Discord thread and the provided workaround; done means the UI loads, generates the search HTML, and search works without the workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, search
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.