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] Use same infra from v5 #2441

Merged
merged 26 commits into from
Sep 13, 2021
Merged

Conversation

DanailH
Copy link
Member

@DanailH DanailH commented Aug 24, 2021

@DanailH DanailH added the docs Improvements or additions to the documentation label Aug 24, 2021
@DanailH DanailH self-assigned this Aug 24, 2021
@DanailH DanailH added the core Infrastructure work going on behind the scenes label Aug 24, 2021
@oliviertassinari

This comment has been minimized.

@oliviertassinari

This comment has been minimized.

@oliviertassinari

This comment has been minimized.

@DanailH
Copy link
Member Author

DanailH commented Aug 24, 2021

I was trying to make the docs work, compile. So this is that effort

@DanailH DanailH changed the title [docs] Fix duplicated Algolia records and package versions [docs] Explore v5 docs migration Aug 24, 2021
@DanailH DanailH closed this Aug 26, 2021
@DanailH DanailH reopened this Aug 26, 2021
@DanailH DanailH marked this pull request as draft August 26, 2021 09:34
@m4theushw

This comment has been minimized.

@m4theushw m4theushw assigned m4theushw and unassigned DanailH Sep 2, 2021
@m4theushw m4theushw marked this pull request as ready for review September 3, 2021 15:56
@m4theushw
Copy link
Member

m4theushw commented Sep 3, 2021

Finally the docs is using the same infra from the core v5. There're still some small things that I'll fix in a follow-up. This PR is already giant.

@m4theushw m4theushw changed the title [docs] Explore v5 docs migration [docs] Use same infra from to v5 Sep 3, 2021
@m4theushw m4theushw changed the title [docs] Use same infra from to v5 [docs] Use same infra from v5 Sep 4, 2021
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a great first iteration. This one required to dive deep into the structure of the repositories, well done

docs/babel.config.js Outdated Show resolved Hide resolved
docs/next.config.js Outdated Show resolved Hide resolved
docs/next.config.js Outdated Show resolved Hide resolved
docs/package.json Outdated Show resolved Hide resolved
docs/pages/_document.js Outdated Show resolved Hide resolved
docs/pages/index.js Outdated Show resolved Hide resolved
@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 4, 2021

Also, it's awesome that we finally reconcile the docs of MUI X with MUI Core 🎉. A couple of feedback to the core:

  1. I think that we have the same side nav issue as with the date picker. It's not very clear what "Demo" refers to. cc @danilo-leal I didn't follow what was the conclusion to it:

Screenshot 2021-09-04 at 13 20 49

https://deploy-preview-2441--material-ui-x.netlify.app/components/data-grid/demo/

  1. Regarding the not correctly themed links in https://deploy-preview-2441--material-ui-x.netlify.app/components/data-grid/events/#catalog-of-events. Maybe we need to expose a branding theme provider component to wrap this demo cc @mnajdova, @siriwatknp.

Screenshot 2021-09-04 at 13 26 38

@danilo-leal
Copy link
Contributor

  1. I think that we have the same side nav issue as with the date picker. It's not very clear what "Demo" refers to. cc @danilo-leal I didn't follow what was the conclusion to it:

Let me quickly separate the answer into two topics:

  1. Visual: in regards to the visual conclusion of nested levels, we haven't yet implemented it yet but I left a simple suggestion on the previous Markdown polish PR for addressing it.
  2. Content: we decided to create a new PR and not use the Markdown polish PR for rearranging the grouping of links on the side nav. We also haven't done it yet. But reflecting specifically about the Data Grid Demo page, I'm not sure if we need to have it stand-alone, it seems weird. I'd think that it makes more sense to have a Demo section probably on the Getting Started page or something like that. I went to GA looking for pageviews and, in the last month, Demo had 18k and Getting Started had 16k. They're not too far away so I suppose it wouldn't be that much of a problem to merge them?!

Anyway, I think we should probably create a second Docs polishments PR for addressing these two (visual solution for nested levels on the sidebar and content regrouping) and other small details left open from the first PR. We can move these discussions further there. It would be nice to do that before v5 stable. How do you feel about it? @mnajdova @siriwatknp

docs/pages/_app.js Outdated Show resolved Hide resolved
docs/package.json Outdated Show resolved Hide resolved
packages/eslint-plugin-material-ui/package.json Outdated Show resolved Hide resolved
@flaviendelangle
Copy link
Member

image

Why did we rename the "Overview" page "Overview" ? It's creating visual redundancy.

@m4theushw m4theushw merged commit e9a18b3 into mui:next Sep 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants