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.

Sign up for GitHub

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

Jump to bottom

wrong info in docs page about search #1781

Closed
drammock opened this issue Apr 23, 2024 · 2 comments · Fixed by #1988
Closed

wrong info in docs page about search #1781

drammock opened this issue Apr 23, 2024 · 2 comments · Fixed by #1988
Labels
good first issue Good for newcomers kind: documentation Improvements or additions to documentation

Comments

@drammock
Copy link
Collaborator

drammock commented Apr 23, 2024 •
edited
Loading

this page: https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/search.html
says that the magnifying glass icon is the default, but it's not. The default for search is the (pseudo-)field that shows the Ctrl+K shortcut. We should correct that info.

This page: https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/layout.html#header-sections
also has incorrect info about the search-button being a default value in the navbar_persistent component.
@drammock drammock added good first issue Good for newcomers kind: documentation Improvements or additions to documentation labels Apr 23, 2024
@drammock drammock mentioned this issue May 3, 2024
Open
@kaycebasques
Copy link
Contributor

This page says that the magnifying glass icon is the default, but it's not. The default for search is the (pseudo-)field that shows the Ctrl+K shortcut.

It's correct for narrow viewports:

image

But not for wide viewports:

image

(I'm taking an attempt at fixing this issue.)

kaycebasques added a commit to kaycebasques/pydata-sphinx-theme that referenced this issue Sep 19, 2024
@kaycebasques
docs: Fix search UI description
09d9c43 
Updates the search doc in the user guide to describe the default
search UI on both narrow and wide viewports.

Also breaks all lines in the doc at 80-characters width.

Fix: pydata#1781
@kaycebasques kaycebasques mentioned this issue Sep 19, 2024
Merged
@kaycebasques
Copy link
Contributor

@drammock proposed fix in #1988

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers kind: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Fix search UI description kaycebasques/pydata-sphinx-theme
2 participants
@drammock @kaycebasques