Qiskit / Qiskit/documentation

Search: group results by page

Open
#1,060 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design 🎨 infra 🏗️ search 🔍
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

Our search results are flat right now, like how the first two results here are for the same page

image

Compare this to instead grouping the results by page, like this from Next.js docs

image

This change needs to happen in the closed source docs app.

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

The requested change is in the closed source docs app, not this repository, so there are no files or tests here to inspect. Start by confirming where the search UI and its result grouping are implemented in that app, then compare its current flat results with the supplied Next.js example. Done means search results are grouped by page as shown.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.