Skip to content

Improve documentation search from python.org #154

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

Open
willingc opened this issue Apr 21, 2025 · 3 comments
Open

Improve documentation search from python.org #154

willingc opened this issue Apr 21, 2025 · 3 comments
Labels
discuss with PSF Needs discussion with PSF Board and/or staff

Comments

@willingc
Copy link
Collaborator

Use case

A new user makes a good point that searching python.org is unhelpful: https://www.python.org/search/?q=json.dumps . The search returns "No results found." The current Django python.org search only searches the site's content itself.

Goal

Improve the user experience.

Considerations

The python.org site is a PSF asset and changes to the site would need to be supported by PSF and their infra team.

Possible solutions from least effort to most effort

  • Do nothing. Keep the status quo.
  • Make the PSF aware of this behavior and ask what they would like to do
  • Work with PSF to implement an addition to the search results page on python.org: "If you don't find what you need here, try searching at https://docs.python.org/"
  • Add an explicit documentation search button that redirects to docs.python.org's search.
  • Develop integrated search on python.org site. This would be a PSF effort.

Summary

For now this is a bit out of scope for the docs-community to tackle alone. Any change would be a joint PSF and CPython docs effort with the PSF taking the lead. cc/ @python/editorial-board

@willingc willingc added the discuss with PSF Needs discussion with PSF Board and/or staff label Apr 21, 2025
@methane
Copy link
Member

methane commented Apr 21, 2025

These are potential document search engines that I'm aware of.

@willingc
Copy link
Collaborator Author

Thanks @methane. mellisearch looks compelling for open source projects. I haven't used this in production but it looks good and after playing around it's nicely performant.

@nedbat
Copy link
Member

nedbat commented Apr 24, 2025

I made a pull request for adding a link to the python.org search page: python/pythondotorg#2718 It suggests redoing the search at docs.python.org, with a link pre-populated with the search query.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss with PSF Needs discussion with PSF Board and/or staff
Projects
None yet
Development

No branches or pull requests

3 participants