-
Notifications
You must be signed in to change notification settings - Fork 5.8k
PTB Docs Search Overhaul #3218
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
PTB Docs Search Overhaul #3218
Conversation
modelled after most common search queries
Pfew, that's quite something that you've cooked up! I feel like the things like toggling the result types, adjusting the theme (colors and light/dark mode) and mobile support are things that go beyond "I'm doing a little tweaking" and should rather be proposed to upstream. Maintaining this exclusively for/as part of PTB is not something that I would look forward to. |
Yes, I did think about writing an issue for this but then I was not sure what I would ask them since:
So I decided to just fork and make own changes. Maintaining shouldn't be too much of a problem? Worst case would be that it would just fallback to regular default search. I do think here that the positives outweigh the negatives |
I see your points, but have a different view point regarding the negatives & the positives … at least until support for mobile devices is enhanced (apart from the "search for" toggle being way off to the right, the search box is "striked through" by the blue separator bar, at least for me) |
LGTM :) @Poolitzer do you want to have a look as well? |
Yes I like the CSS look now good job! I just realized going backwards/forwards one page does not show the search again, is that fixable? Even worse if you filter stuff out, all of that apparently generates a new page. Makes you think the browser broke :D |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess from my side everything's fine now, just two tiny nitpicks below. @Poolitzer do you have any change requests left?
Almost happy. Back and forth works great now, but if you
The search is not triggered. Is that fixable? Then I am happy. |
Introduces Search-as-you-type and Advanced Search — the ability to search by the type of object — Class, Attribute, Method, Parameter, or just the documentation in general.
demo.mp4
Where can I test this?
https://docs.python-telegram-bot.org/en/doc-search/
Note for reviewers:
Things which can be improved further:
The theme is dark mode by default. We can try to support light mode if we get enough requests.Implemented.On mobile, the positioning of elements is currently broken.Fixed.Design / colors of all elements! I tried to improve this as much as possible, but I'm no css wizard.Much improved! Suggestions on what to improve are welcome.Things which can't (really) be improved: