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

Documentation search functionality seems hobbled #2386

Open
rmartin16 opened this issue Feb 9, 2024 · 3 comments
Open

Documentation search functionality seems hobbled #2386

rmartin16 opened this issue Feb 9, 2024 · 3 comments
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features.

Comments

@rmartin16
Copy link
Member

What is the problem or limitation you are having?

When using the search functionality on RTD, the results seem limited and less useful than they could be. Given the prominent search box is the obvious method to find arbitrary information in the documentation, this makes it harder to find what I'm looking for.

Describe the solution you'd like

Consider searching for "dialog"; ideally, the search result would include all of the dialog methods on Window. Instead, it only includes the stack_trace_dialog (and the presentation of the search result doesn't make even that clear).

This clearly isn't Toga functionality per se....but perhaps it's possible to improve how the search results behave.

Describe alternatives you've considered

If I know something exists but can't find it in the docs, I'll perform a GitHub search instead.

Additional context

No response

@rmartin16 rmartin16 added enhancement New features, or improvements to existing features. documentation An improvement required in the project's documentation. labels Feb 9, 2024
@rmartin16
Copy link
Member Author

Interestingly, the search results from the docs built on my local machine are particularly more useful...

image

@HalfWhitt
Copy link
Contributor

Odd... when I do it on the site, I get results for stack_trace_dialog, select_folder_dialog, and open_file_dialog. Though yes, the presentation of them is unhelpful. It looks like it's only searching for the entire word, so it finds it as a return type and occurring in text, but not the method names themselves.

Screenshot 2024-02-09 at 6 01 21 PM

What's also odd is that my locally built version lists the same results as yours, but without the highlighted text summaries yours has.

Screenshot 2024-02-09 at 6 02 29 PM

@rmartin16
Copy link
Member Author

This still really bothers me....and it isn't even that RTD and locally built docs handle search differently....docs built for PRs on RTD work while search for stable docs are bad....

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features.
Projects
None yet
Development

No branches or pull requests

2 participants