racket / racket/scribble

Chrome omnibox site-search support

Open
#81 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

If I type stackoverflow.com into the Chrome omnibox without pressing enter a little "Press tab to search Stack Overflow" note pops up:

screen shot 2017-02-16 at 1 13 29 pm

Now I can search StackOverflow directly without having to load the page, wait for the search box to render, navigate to the box, and type in my search. I just press tab and go. This happens without any configuration or effort on my behalf. I'd like it if the docs.racket-lang.org website did the same, as searching those docs is very common for me even outside DrRacket.

Apparently, this works through the OpenSearch standard. For Scribble to support this there would need to be a link in the generated HTML to an OpenSearchDescription XML document, as described in this StackOverflow question.

Contributor guide

No contributing guide indexed for this repository

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 examining Scribble's generated HTML output and the OpenSearch standard linked in the issue. Add the required OpenSearchDescription XML and the corresponding link in generated documentation pages, then verify that docs.racket-lang.org exposes the Chrome omnibox search prompt.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.