René's URL Explorer Experiment


Title: PTB Docs Search Overhaul by harshil21 · Pull Request #3218 · python-telegram-bot/python-telegram-bot · GitHub

Open Graph Title: PTB Docs Search Overhaul by harshil21 · Pull Request #3218 · python-telegram-bot/python-telegram-bot

X Title: PTB Docs Search Overhaul by harshil21 · Pull Request #3218 · python-telegram-bot/python-telegram-bot

Description: 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: I made a fork of readthedocs/readthedocs-sphinx-search and used that here, since the number of changes to both the theme and the javascript was drastic enough. You can review the changes here. We can also discuss moving this to the PTB-organization if wanted. Things which can be improved further: Assign a keyboard shortcut for opening advanced search? Maybe also one to clear the input field. 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: Search results when there are typos in your query, or you're searching for two closely matching words. Since RTD's backend for search is ElasticSearch, one would have to follow the Advanced Search Syntax to get a better result.

Open Graph Description: 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....

X Description: 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....

Opengraph URL: https://github.com/python-telegram-bot/python-telegram-bot/pull/3218

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:0bcabc14-25ec-1651-08c7-2598588ec27d
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id86F0:7189C:32C333:42AC88:6B025450
html-safe-nonce7e67f9abee47562beb57addac6e61e5395a389df26d377bc85ceb928941b794f
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NkYwOjcxODlDOjMyQzMzMzo0MkFDODg6NkIwMjU0NTAiLCJ2aXNpdG9yX2lkIjoiNzc3MDM4MTAwMzIzMDY5NjUyOCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacb259de16454f26132bf49e595d87491a5d2e4b42e8b76ee8135c042a1c64cf0c
hovercard-subject-tagpull_request:1041710042
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
twitter:imagehttps://avatars.githubusercontent.com/u/37377066?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/37377066?s=400&v=4
og:image:altIntroduces 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....
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/python-telegram-bot/python-telegram-bot git https://github.com/python-telegram-bot/python-telegram-bot.git
octolytics-dimension-user_id16178365
octolytics-dimension-user_loginpython-telegram-bot
octolytics-dimension-repository_id38696925
octolytics-dimension-repository_nwopython-telegram-bot/python-telegram-bot
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id38696925
octolytics-dimension-repository_network_root_nwopython-telegram-bot/python-telegram-bot
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fpull%2F3218%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fpull%2F3218%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=python-telegram-bot%2Fpython-telegram-bot
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
python-telegram-bothttps://github.com/python-telegram-bot
python-telegram-bothttps://github.com/python-telegram-bot/python-telegram-bot
Codehttps://github.com/python-telegram-bot/python-telegram-bot
Issues23 (23)https://github.com/python-telegram-bot/python-telegram-bot/issues
Pull requests19 (19)https://github.com/python-telegram-bot/python-telegram-bot/pulls
Discussionshttps://github.com/python-telegram-bot/python-telegram-bot/discussions
Actionshttps://github.com/python-telegram-bot/python-telegram-bot/actions
Projectshttps://github.com/python-telegram-bot/python-telegram-bot/projects
Wikihttps://github.com/python-telegram-bot/python-telegram-bot/wiki
Security and qualityhttps://github.com/python-telegram-bot/python-telegram-bot/security
Insightshttps://github.com/python-telegram-bot/python-telegram-bot/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2Fnew%2Fchoose
harshil21https://github.com/harshil21
doc-fixeshttps://github.com/python-telegram-bot/python-telegram-bot/tree/doc-fixes
doc-searchhttps://github.com/python-telegram-bot/python-telegram-bot/tree/doc-search
Conversation 10 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218
Commits 21 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits
Checks 0 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/checks
Files changed https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
Please reload this pagehttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
PTB Docs Search Overhaul https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#top
Show all changes 21 commits https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
690d0c0 test if rtd-search extension works with furo harshil21 Aug 29, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/690d0c080a0c04c0a314845e26a245f72a26622a
cfa8dab change search ranking harshil21 Aug 29, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/cfa8dab01396975ae86c837eb5f090629d5abb0e
3b2d1f2 try un-minified version of search box to improve ui harshil21 Aug 29, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/3b2d1f292fff4e650fc8674f4b1283b1934e731e
5f6b955 apply theme fixes harshil21 Aug 29, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/5f6b955819038cf35eec94c218e63768d398f61d
45783d5 fix search priority? harshil21 Aug 29, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/45783d567870250094554185aa5fd4d547e97e7b
7c81426 get started on improving results harshil21 Aug 29, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/7c8142628ced7e86222fd3aedeb3c2f56e246dfd
31f9d13 modify search ranking again harshil21 Aug 30, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/31f9d133b0bf0d2135cf7716609435ad6c675032
d18c065 move rtd-sphinx-search to a forked repo harshil21 Aug 31, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/d18c065f9c78f2d0ca0ff8dffdd969bb3d019658
a401832 use minified config and trigger doc re-run harshil21 Sep 3, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/a401832d702723682c239fa9b9d790ade5135f3c
1b61de3 trigger doc re-run harshil21 Sep 4, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/1b61de35b86ad7b1f9fe7ab05bb7ecd482257836
fc6e7c0 use renamed fork harshil21 Sep 4, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/fc6e7c0a26cc4c6ab5f18c5bef18b31d27f2b561
46d64e0 trigger doc re-run harshil21 Sep 4, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/46d64e0a153dbfe36f513d582b0f046d1afafad6
29bb0a8 trigger re-run 4 harshil21 Sep 4, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/29bb0a85539eb98b2f67a69073920bda0e5fdcb8
de858a4 ignore some files from search harshil21 Sep 9, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/de858a4f067a6a4c1ae8fa80fc38705e5c052d13
1706403 trigger rebuild harshil21 Sep 9, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/17064037a485f6d01f389ee2f2af855cdb5b6919
6b5a4d1 last rebuild for day harshil21 Sep 9, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/6b5a4d18e148dfed4b7636734acb664a5bc9f55d
54b4e22 review + add egg project name and one more ignored file in search harshil21 Sep 11, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/54b4e22c642b6368f2e5be3350b4b1cacbfab4dc
fad4aca fix search not triggering when query present bug harshil21 Sep 12, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/fad4aca32adf915c60f6b35bccbe0e76528c8a3b
f883fb6 bump furo and use py3.11rc2 harshil21 Sep 16, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/f883fb6f28f6eee3b33fcb7125e1feab28bfd2c3
05d8a72 merge doc-fixes harshil21 Sep 17, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/05d8a723b5c3e467045d8f1d3e6f716dc9f60800
27814fe revert upgrading to py3.11rc2 here harshil21 Sep 17, 2022 https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/commits/27814fecf5599fc61881eb2584f0090e88c782a2
Clear filters https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
Please reload this pagehttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
Please reload this pagehttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files
.readthedocs.yml https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-cde814ef2f549dc093f5b8fc533b7e8f47e7b32a8081e0760e57d5c25a1139d9
requirements-docs.txt https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-83a2c35e96bebb6568c54f925745c66f5dd4f29d565cd7de6cb70147fdbdb05c
conf.py https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
.readthedocs.ymlhttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-cde814ef2f549dc093f5b8fc533b7e8f47e7b32a8081e0760e57d5c25a1139d9
View file https://github.com/python-telegram-bot/python-telegram-bot/blob/27814fecf5599fc61881eb2584f0090e88c782a2/.readthedocs.yml
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/{{ revealButtonHref }}
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-cde814ef2f549dc093f5b8fc533b7e8f47e7b32a8081e0760e57d5c25a1139d9
docs/requirements-docs.txthttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-83a2c35e96bebb6568c54f925745c66f5dd4f29d565cd7de6cb70147fdbdb05c
View file https://github.com/python-telegram-bot/python-telegram-bot/blob/27814fecf5599fc61881eb2584f0090e88c782a2/docs/requirements-docs.txt
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/{{ revealButtonHref }}
docs/source/conf.pyhttps://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
View file https://github.com/python-telegram-bot/python-telegram-bot/blob/27814fecf5599fc61881eb2584f0090e88c782a2/docs/source/conf.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/{{ revealButtonHref }}
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com/python-telegram-bot/python-telegram-bot/pull/3218/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.