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

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

Closed
wants to merge 1 commit into from

Conversation

mr-robot-2211
Copy link

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

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

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

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.
#1546

@pauloxnet
Copy link
Contributor

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

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!

@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.

Add explicit note about the browser bar integration via OpenSearch description
3 participants