django / djangoproject.com

Source code to djangoproject.com
https://www.djangoproject.com/
BSD 3-Clause "New" or "Revised" License
1.86k stars 939 forks source link

Add Documentation for Browser Search Integration via OpenSearch #1546

Closed mr-robot-2211 closed 2 weeks ago

mr-robot-2211 commented 2 weeks ago

ticket-#1228

Description

This pull request adds documentation for integrating browser search functionality using the OpenSearch standard in the Django project.

Changes Made

Details

Integrating browser search via OpenSearch enhances user experience by allowing them to search the site directly from their browser's search bar. The documentation covers essential steps and considerations for implementing this feature effectively.

Testing

I tested the provided instructions by creating a sample OpenSearch description file and verifying its functionality in various browsers.

Additional Information

This contribution aligns with the project's goal of improving usability and accessibility.

Request for Review

Please review and provide feedback on the documentation. I am open to making any necessary adjustments based on your suggestions.

bmispelon commented 2 weeks ago

Hi,

I'm not sure what's going on here, but it seems there's a misunderstanding about what the original ticket is asking. The idea is to have a visible way for the users of the site to know that they can add the opensearch plugin to their browser.

In this new pull request, you have deleted the XML file that the site uses to generate our opensearch plugin, and added a documentation file in a place where no one will see it (we don't produce sphinx documentation of the docs/ folder, it's a regular Django app that contains views/templates/... for the website). I don't see how that addresses the original issue.