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

Improved searching in online docs #2304

Open
KoBeWi opened this issue Mar 27, 2019 · 1 comment
Open

Improved searching in online docs #2304

KoBeWi opened this issue Mar 27, 2019 · 1 comment
Labels
content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement

Comments

@KoBeWi
Copy link
Member

KoBeWi commented Mar 27, 2019

Online docs have some searching problems that make me rather search in Google than trying to do it directly there.

The thing that sets me back the most is that when you search anything in the search field and then click any result, it will enable highlighting of whatever you looked up. It's just annoying to have yellow-marked texts all over the place and I can't the only one who doesn't like it and doesn't find useful. At most, it should be optional.

Another thing is some better support for on-page searching. E.g. you go to Godot API page and try to find specific class with Ctrl + F. Instead of text on that page, the left panel will be highlighted first. This might not sound like useful example, but often you want to find specific thing in some class and trying to search anything puts you into long list at left panel. So either some option to search specific page should be provided or we should be able to hide the left panel when unnecessary. (or maybe do some magic, so Ctrl +F will look into the left panel as last option, instead of starting there)

@Calinou
Copy link
Member

Calinou commented Mar 27, 2019

The thing that sets me back the most is that when you search anything in the search field and then click any result, it will enable highlighting of whatever you looked up. It's just annoying to have yellow-marked texts all over the place and I can't the only one who doesn't like it and doesn't find useful. At most, it should be optional.

I'm not sure if this can be controlled from our side, as Read the Docs does it by default. In the worst case, we could hide them by overriding the .highlighted selector with custom CSS.

@skyace65 skyace65 added the content:website Issues related to adding website features and fixing bugs, whether on the front or back-end label Dec 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement
Projects
None yet
Development

No branches or pull requests

3 participants