canonical / canonical/vanilla-framework

Search autocomplete for docs

Open
#2,919 2 comments 0 reactions 0 assignees View on GitHub
Feature 🎁 P3 Triaged Priority: Medium Triaged: Pragma
Dominant language
HTML
Stars
983
Forks
216
Avg merge
3d 13h
Merged PRs (30d)
3

Description

When discussing search improvements it was mentioned that we could implement search with autocomplete functionality.

https://github.com/canonical-web-and-design/design-vanilla-framework/issues/445#issuecomment-578179183

![vanilla-site-search](https://user-images.githubusercontent.com/19801137/73080114-38265a00-3ebd-11ea-950e-a7677c6bcf4f.png)

Material UI:

![Screenshot 2020-03-11 at 13.28.23.png](https://images.zenhubusercontent.com/593a660851aa2c30578102bb/b7098e8c-38df-4462-9447-0fe53f4351e4)

We have backend in Flask for search. We could try implementing autocomplete search for docs with results from search API.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked design discussion and the existing Flask search backend/API. Then identify the docs search entry point and determine how autocomplete results should match the provided screenshots. Done means documented behavior and an autocomplete experience that returns relevant docs results from the search API.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask
Domain
api, frontend, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.