restify / restify/node-restify

[Docs Site] Remove search bar

Open
#1,539 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Critical Docs Help Wanted
Dominant language
JavaScript
Stars
10.7k
Forks
975
Avg merge
1d 6h
Merged PRs (30d)
5

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the restify.com docs site's search bar and reproducing the reported behavior in the listed browsers. Clarify whether the intended result is to remove the search bar, as the title says, or restore search initiation, as the expected result says; completion depends on that decision.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.