Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] System Typography page is first search result for Typography #19986

Closed
danawoodman opened this issue Mar 4, 2020 · 9 comments
Closed
Labels
docs Improvements or additions to the documentation

Comments

@danawoodman
Copy link

danawoodman commented Mar 4, 2020

Seems strange that the docs site shows <Box> components for the <Typography> docs:

https://material-ui.com/system/typography/#typography

@mbrookes mbrookes added the docs Improvements or additions to the documentation label Mar 4, 2020
@mbrookes
Copy link
Member

mbrookes commented Mar 4, 2020

That's the Typography page for the System package. The Typography docs are here:

https://material-ui.com/components/typography/
https://material-ui.com/api/typography/

Perhaps we somehow need to make it clearer what section a page belongs to.

@danawoodman
Copy link
Author

Ah, that wasn't obvious. That page is the first result when searching for "Typography":

@mbrookes
Copy link
Member

mbrookes commented Mar 4, 2020

I noticed that too. I think we should leave this open for now.

@mbrookes mbrookes reopened this Mar 4, 2020
@mbrookes mbrookes changed the title [docs] "Typography" docs show "Box" component examples [docs] System Typography page is first search result for Typography Mar 4, 2020
@mbrookes
Copy link
Member

mbrookes commented Mar 4, 2020

I've changed the subject to reference the search result as that's the entry point to the source of confusion, but I also think we could make the distinction clearer on the page. (Add breadcrumbs? Change the System page headings to "System – Pagination"? Something else?)

@joshwooding
Copy link
Member

Is there a way to show component pages first as well? I would expect most searches are looking for the component pages rather than the System pages.

@mbrookes
Copy link
Member

mbrookes commented Mar 5, 2020

Is there a way to show component pages first as well?

That was the main point, as reflected by the change of subject. @oliviertassinari would be best to answer, as he has singularly developed the Algolia integration.

@oliviertassinari
Copy link
Member

oliviertassinari commented Mar 6, 2020

I think that the introduction of a breadcrumb has potential.
Regarding Algolia, I have no idea how they rank the content in this case. I believe we have another issue open related to improving the ranking of Algolia. For instance, I have noticed that, sometimes, it display the component page before the API page, sometime, the opposite.

@siriwatknp
Copy link
Member

I added my findings here, will try to fix it. #16502 (comment)

@siriwatknp
Copy link
Member

This is fixed. Here is the proof

Screen Shot 2564-10-04 at 09 45 47

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

5 participants