xmake-io / xmake-docs

The xmake online documentation site
https://xmake.io
49 stars 101 forks source link

Fixed search bar position #104

Closed iAndyHD3 closed 1 year ago

iAndyHD3 commented 1 year ago

Is your feature request related to a problem? Please describe.

Using the documentation page can be frustrating when searching for information multiple times due to the search bar being located at the top of the sidebar. As users scroll down to view all the results, the search bar becomes hidden and difficult to locate again, forcing them to scroll all the way up to the top of the sidebar. This causes inconvenience and hinders the user experience.

Furthermore, this problem is compounded by the fact that users may not even be aware of the search bar's existence in the first place. For example, when I first accessed the documentation page, I completely missed the search bar as it is not immediately apparent that it is located at the top of the sidebar. Since my intention was to scroll down to browse the site, I spent several days unaware of the search bar's existence.

Describe the solution you'd like

To improve the user experience, it would be beneficial to have the search bar remain fixed at the top of the page Additionally, it may be helpful to make the search bar more prominent and visible to ensure that users are aware of its existence, for example by adding a search bar icon.

Describe alternatives you've considered

not really any, fixing the search bar position should be straight forward

Additional context

The search bar I'm referring to if it wasn't clear. image

waruqi commented 1 year ago

We use an open source documentation framework: https://github.com/docsifyjs/docsify

This is their built-in search module. But I don't know how to improve it, maybe you should open issues in docsify would be appropriate.

iAndyHD3 commented 1 year ago

Alright thanks, I was completely unaware of this. I'll see if I can open an issue there.