oxidecomputer / oxidecomputer/rfd-site

Add OpenSearch registration

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
214
Forks
22
Avg merge
6d 4h
Merged PRs (30d)
12

Description

OpenSearch allows a site to register itself as a search engine that can be installed in the user's browser. Adding this metadata to the RFD site would allow users to quickly install it as a shortcut. I can see two ways this could be done:

  1. Register https://rfd.oxide.computer/%s so that "searching" is just looking up a numerical RFD. This is very easy.
  2. Register an endpoint which redirects to a numbered RFD if the search is a literal number, or engages full-text search if not (I suspect this endpoint would need to be created).

This work could be phased: (2) is a generalization of (1). However, if some users install the search engine after (1), they would not receive the benefits of (2) unless they manually re-register the search engine again. For this reason I suggest simply implementing (2) directly.

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 locating the RFD site's search entry point and the page metadata used for browser discovery. Determine how a literal RFD number and a full-text query should be routed, then add the OpenSearch registration and verify that both search cases produce the expected result.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.