Comments (10)
For some pages, there are filters. For example searchin when you are in a picker docs pages, search query will get the attribute optionalFilters: ["productId:x-date-pickers"]
Some url such as mui.com
don't have those filters, because from it we can not now if user is looking for the core, X, or toolpad docs
But we could look for lowering the importances of toopads API pages, because if they put one page per components, they will always appear first
from material-ui.
Given there was a quick fix for the original/more immediate problem, I went ahead and rephrased the issue's title so it reflects the "filter the search scope" feature mentioned above that we'll want to explore at some point to potentially solve the issue more holistically!
from material-ui.
Regression fixed, https://mui.com/ is back to the baseline:
Details. When I do the search of @oliviernt's query "date picker" in the Agolia's UI, it tells me that pageRank
is the tie-breaker:
Which doesn't make sense to me. Turns out, it's a regression I introduced on a bug I fixed. This change solved the problem:
// % from https://docs.google.com/spreadsheets/d/1x9uTSMlu4xug2SfHrvr5amZ2HokYBoQaSozHmRRdVqw/edit#gid=907743010
const baselinePopulartyProductId = {
material-ui: 83,
- "mui-x": 12,
+ x: 12,
system: 4,
"base-ui": 2,
"joy-ui": 2,
toolpad: 1,
};
It needed to match with:
material-ui/docs/src/modules/utils/getProductInfoFromUrl.ts
Lines 3 to 15 in 6da671c
Now, I don't think we should close this issue until the larger discussion goes to completion. It's point 3. of #16502. What we could explore:
- On the homepage, maybe we should have a clear toggle in the search to select a product, e.g. https://nextjs.org/
AWS
MUX https://docs.mux.com/?q=al
- Should it even be possible to have non Material UI results show in between Material UI ones?
It feels like it only makes sense for when you are on https://mui.com/, but anytime you go to a product, it should only show that product results. We could make this change:
customRanking: [
"desc(weight.pageRank)",
"desc(weight.level)",
"asc(weight.position)",
"desc(weight.popularity)",
],
ranking: [
+ "filters",
"words",
- "filters",
"typo",
"attribute",
"proximity",
"exact",
"custom",
],
but it's kind of strange. Or, we could also make two different searches one with the filter set, and one without, so we would only show one type of results at the time. Or we could just hide all non-product related results, forcing developers to go to each doc. This might be best.
from material-ui.
Yeah, I agree that having the option to tailor the search results ranking to your preference would be great! We'd still need a ranking from our side, though, because if you're a new visitor accessing the website for the first time, you wouldn't have a preference just yet. So, considering this specific example, Toolpad's Date Picker docs page shouldn't be the first resource that pops up if you're looking for that.
from material-ui.
Hey @oliviernt, thanks for opening the issue! I'm not immediately opposed to your suggestion, but I think there's some bug with the Algolia search ranking that's not suggesting the most relevant page, which, in this case, should be the Date Picker component docs from MUI X instead of Toolpad. @mui/docs-infra, any ideas here?
from material-ui.
Hey @alexfauquette @danilo-leal, thank you both for your fast response time.
Lowering the importance of toolpad would indeed, solve my current issue but it could possibly deteriorate the experience for other users.
My idea was that selecting which products I'm interested in would make a nice feature in itself. It would reduce the search scope, allow for people intereseted in toolpad (or any other product) to select that and make it flexible in the long run as you guys are providing more and more products...
from material-ui.
Thank you for the fix! 🚀
My personal 2 cents on both points:
-
for me the ideal solution would be to have a persisted multiple choice select of the product docs I'm searching in.
As we're working with Material UI, I'm normally nor interested in the BaseUI, JoyUI or Toolpad docs. I do know they exist and I know how to access them if I need to... -
I think it's nice to have results related to the seach in there as sometimes it might just be the one piece of advice one missed.
from material-ui.
It needed to match with:
Looks like we are missing x-tree-view
by the way
from material-ui.
Looks like we are missing x-tree-view by the way
@flaviendelangle On view-source:https://next.mui.com/x/react-tree-view/ I see:
<meta name="mui:productId" content="x-tree-view"/><meta name="mui:productCategoryId" content="x"/>
We are good.
from material-ui.
But shouldn't we have x-tree-view
in material-ui/docs/src/modules/utils/getProductInfoFromUrl.ts ?
from material-ui.
Related Issues (20)
- [material-ui] Not able to build the project when updating to Next.js 14.2.2 with v5.15.15 HOT 5
- [code-infra] Replace all references of event as e HOT 6
- [material-ui][theme] Array syntax doesn't work for values in styleOverrides in theme HOT 4
- MRT Infinite Scrolling with RTK Query HOT 1
- [docs-infra] Show plan on API pages
- [docs] need for a blog about how to optimize MUI
- [material-ui][Grid] Make the v2 component version stable
- [docs-infra] Using the right to left feature with browser translators HOT 5
- [joy-ui][Select] Floating label Select HOT 4
- [material-ui][AlertTitle] Missing Typography props when using AlertTitle
- [joy-ui][Radio] Can't use a checked icon/unchecked icon when setting a background color HOT 1
- [docs][material-ui] Slider in color customization playground twitches when sliding HOT 3
- [material-ui][TableRow] Exported variable 'StyledTableRow' has or is using name 'UNDEFINED_VOID_ONLY' HOT 1
- [material-ui] Button and few more components CSS styling are off when use with Bootstrap 5.3.3 HOT 1
- [system] Unnecessary media query with 0px breakpoints HOT 3
- [material-ui] How to reduce bundle size? HOT 2
- [@mui/styles] React 17 dependency HOT 1
- [code-infra] Migration to ESLint v9
- Compatibility with React 19 types
- [docs] Introduce User Persona for Enhanced Portuguese/Brazilian Documentation HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from material-ui.