mui / mui/material-ui

[docs-infra] Add capacity to filter the search scope

Open
#41,541 10 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

scope: docs-infra type: new feature
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Summary

Often when I search for something on the MUI docs through the Algolia search (Strg + K), I'm presented irrelevant search results for the Toolpad components first.

It'd be great to have the ability to exclude products from search.

Examples

Example of the results when searching for "DatePicker"

image

Motivation

No response

Search keywords: search toolpad

Contributor guide

Open the contributing guide

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 tracing the MUI docs' Algolia search integration used by Strg + K and identify where Toolpad components enter the results. Define how products should be excluded from the search scope, then verify that searches such as "DatePicker" no longer prioritize excluded products.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.