mui / mui/material-ui

[Web][Docs] Search bar result contetnt on v5 documentation page

Open
#29,444 0 comments 0 reactions 1 assignee View on GitHub

@siriwatknp is already working on this.

Since Nov 1, 2021.

docs scope: all components
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

  • Allow (maybe hard-bind?) abbreviations in search (like btn for button, btn group etc)
  • Progressive search outcomes on user input. (when user search wordA wordB, the first result should be the ones from the results from searching only wordA which also contains wordB) See in chapter #Examples.
  • Remove some of current content.
  • NOTE: The second issue(Progressive search outcomes) was categorized as "hard to achieve" due to the algolia engine in this comment

    This is hard because we don't have control to edit search configuration in algolia

  • The issue was initially mentioned here https://github.com/mui-org/material-ui/issues/28415 in this comment
  • This issue is to separate different topics.

Examples 🌈

I would like to have some (limited) access to your prototyping tool like https://siriwatknp.github.io/mui-docsearch/ to make it clearer and easier during the communication.

  • Current behavior
    Current behavior

  • Expected behavior
    I can only describe with text. When user type typo then want to go to typography - general, to do everything without mouse, user would type gen after typo, then the typography - general chapter shows up as the first result.

Motivation 🔦

Usability: to make search easier

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.