node-restify icon indicating copy to clipboard operation
node-restify copied to clipboard

[Docs Site] Remove search bar

Open nwhitmont opened this issue 8 years ago • 4 comments

Site: http://restify.com/ Browsers tested:

  • Chrome (62.0.3202.62 (Official Build) (64-bit))
    • Chrome private browsing
  • Firefox Developer Ed.
  • Safari (Version 11.0 (11604.1.38.1.7)) OS: macOS 10.11.6 El Capitan

Repro steps:

  • Navigate to http://restify.com/ in your browser
  • Type text into searchbox in upper right
  • press enter/return on keyboard, or
  • click magnifying glass icon

unable to search docs with searchbox

Expected result:

  • search is initiated by pressing enter/return on keyboard while search input field is focused
  • search is initiated by clicking on magnifying glass icon

Actual result:

  • enter/return on keyboard does nothing - search not initiated

nwhitmont avatar Oct 23 '17 22:10 nwhitmont

@nwhitmont thanks for reporting it. Was it possible to search for specific content earlier? Like for a particular name of a plugin or a server method? cc @retrohacker

hekike avatar Oct 25 '17 07:10 hekike

I checked out the https://github.com/restify/restify.github.io/blob/master/search.json file but Jekyll basically knows only about the main pages, the content is a black-box. For a more detailed search, we would need to parse the content and use full-text search.

hekike avatar Oct 25 '17 07:10 hekike

@hekike On the old site, I didn't have any issues searching for content. This is the first time I tried the new site since it's been up. Thus the bug report.

It looks like the search box does not actually have "search" functionality as advertised in the pre-populated text inside the search box, which is kinda misleading to the user.

If you are lucky enough to start typing a search term that is then auto-completed, you can click on the auto-complete suggested topic, which does link to a docs page, but real site search is not possible with this "search" box.

The old site design provided better discoverability of documentation topics since there was a static nav menu on the left which persisted across all pages, including the homepage. This was much better experience than the existing site IMHO since the content was right there on the homepage, not hidden behind any links or menus or fake "search" boxes that can't actually search for anything.

As a user of your docs site, I would prefer not to have a search box on the page if it doesn't actually have the ability to search the site contents.

nwhitmont avatar Oct 25 '17 21:10 nwhitmont

@hekike yeah, it has only ever known about pages.

retrohacker avatar Nov 01 '17 22:11 retrohacker