Qiskit / Qiskit/documentation

Search: visually distinguish header vs section results?

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

Nobody has claimed this yet.

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

Description

In search, we have two indexes: headers and "sections", aka the body text. When we show the results to users, the only visual distinction is where we bold the text:

image

Compare this to how Next.js uses a different icon and also doesn't include for headers the surrounding body, and vice versa for sections:

image

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 at the search result UI and trace how the headers and section indexes are rendered. Compare the current result context with the Next.js examples in the issue, then confirm that header and section results have distinct visual treatment and appropriate surrounding text.

Written by the indexing model from the issue text.

Assessment

Domain
frontend, search
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.