Improve Algolia internal search results on mui.com

Listing various points that could be improved for searching our docs. Also documenting unhelpful search results. It’s not about implementing all of those but exploring how viable they are or if they have better alternatives.

Opportunities

• Be able to search inside the content of the page, not just headers.

• Remove the #main-content noise. Reproduction: search for Alert You land on https://mui.com/material-ui/react-alert/#main-content.

• Implement OpenSearch #29445

• Index MUI X. e.g. https://mui.com/x/introduction/licensing/ and related pages. It would solve https://github.com/mui/mui-x/pull/5074#discussion_r898210356

• Index MUI System e.g. https://mui.com/system/getting-started/overview/ and related pages. It would solve https://www.algolia.com/apps/TZGZ85B9TB/analytics/no-results/material-ui?from=2022-09-14&to=2022-09-20.

• Move the product attribute from the crawler configuration https://crawler.algolia.com/admin/crawlers/739c29c8-99ea-4945-bd27-17a1df391902/configuration/edit to the page, e.g. https://github.com/mui/material-ui/blob/29fd59e746b9d7ceec2e692e26f08bc3fd6c566a/docs/data/joy/components/alert/alert.md?plain=1#L2. It would be simpler.

• Index MUI Toolpad, e.g. https://mui.com/toolpad/getting-started/overview/

• Implement https://github.com/mui/material-ui/issues/29445

• Fix moving scrollbar when opening the search (you can test on Windows)

• Migrate the UI to https://github.com/mui/material-ui/issues/32124

• Duplicate lang property https://www.algolia.com/apps/TZGZ85B9TB/explorer/browse/material-ui?page=1&searchMode=objectID

  

  Likely a conflict between

  https://github.com/mui/material-ui/blob/29fd59e746b9d7ceec2e692e26f08bc3fd6c566a/docs/src/modules/components/Head.tsx#L58

  and https://docsearch.algolia.com/docs/record-extractor#indexing-content-for-faceting

• Move popularity and pageRank configuration from the Crawler UI to the markdown pages.

• Use analyticsTags to so that each product team can filter the analytics in the Algolia admin

  

Fix unhelpful results

• “FilledInput” (top 5 results link to /api/filled-input page)
• “material tabs”

[Janpot]

Adding another issue: Searching for “styled”, looking for documentation on the styled utility. Basically, looking for this page: https://mui.com/system/styled/. The page is not there, not even further down the list:

[siriwatknp]

@oliviertassinari Can you open this page and try searching for “migration”, “icons”?

Does the result fix this issue?

Search: “migration”

Search: “icons”