Skip to content

Improve documentation search from python.org #154

Description

@willingc

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

Activity

  1. methane commented on Apr 21, 2025

    @methane
    Member

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

  2. willingc commented on Apr 22, 2025

    @willingc
    CollaboratorAuthor

    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.

  3. nedbat commented on Apr 24, 2025

    @nedbat
    Member

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    discuss with PSFNeeds discussion with PSF Board and/or staff

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions