search

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

Added note about browser bar integration via OpenSearch description (#1228) . #1543

Closed mr-robot-2211 closed 2 weeks ago

mr-robot-2211 commented 2 weeks ago

Issue: Resolves #1228

Changes:

Added a note in the search.py file to document the browser bar integration via OpenSearch description in the Django documentation. The added note explains that users can integrate the Django documentation search directly into their browser's search bar using the provided OpenSearch description.

Context: This change addresses issue #1228, which requests the addition of explicit documentation about browser bar integration via OpenSearch description. By adding this note, users will have clear instructions on how to utilize this feature, enhancing the usability of the Django documentation.

Testing:

Checked that the note appears correctly in the search.py file. Reviewed the documentation build process to ensure that the note does not cause any errors or warnings. Manually verified that the note is visible in the rendered documentation.

Additional Notes: Ensured that the note is clear and concise, providing relevant information to users. Open to feedback and suggestions for further improvements.

bmispelon commented 2 weeks ago

Hello, and thanks for your contribution!

The original issue is a bit unclear as to where this documentation should appear, but I believe it was meant to be shown to users of the site, not inside the python code.

@pauloxnet Can you clarify what you meant in the original ticket?

mr-robot-2211 commented 2 weeks ago

Sorry for misunderstanding the issue. I have created another pull request where i have given instructions for open search in a separate file. Please do check and let me know if something else has to be done instead. https://github.com/django/djangoproject.com/pull/1546

pauloxnet commented 2 weeks ago

Hello, and thanks for your contribution!

The original issue is a bit unclear as to where this documentation should appear, but I believe it was meant to be shown to users of the site, not inside the python code.

@pauloxnet Can you clarify what you meant in the original ticket?

I tried to add some details in the issue #1228

bmispelon commented 2 weeks ago

Closing this one since #1546 replaces it.

For future reference, next time you can also reuse the same pull request/branch, no need to open another one.

Thanks!