Skip to content
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

Add Documentation for Browser Search Integration via OpenSearch #1546

Closed
wants to merge 1 commit into from

Conversation

mr-robot-2211
Copy link

@mr-robot-2211 mr-robot-2211 commented Jun 14, 2024

ticket-#1228

Description

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

Changes Made

  • Added opensearch_integration.rst file in the docs directory.
  • Documented steps to create an OpenSearch description file (opensearch.xml), serve it, and add a link tag to HTML.
  • Provided instructions for testing the OpenSearch integration.

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
Copy link
Member

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.

@bmispelon bmispelon closed this Jun 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants