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][Charts] Give a general revision to the docs #11249

Merged
merged 12 commits into from
Dec 5, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Nov 29, 2023

This PR gives a general revision to the MUI X Charts space, proposing changes such as:

  • Tweaking the page hierarchy structure by adding section dividers ("Available components", "Future components", and "Customization"). I believe this makes it easier to consume our different types of content.
  • Copywriting and formatting changes to the Overview page.
  • Fixing all demo instances that are meant to be a "Playground", so the design is consistent with all other MUI docs!
  • Standardizing how we display planned future components to what we do on Core — removing the emojis from the title, adding the "Planned" chip, and tweaking the callout copywriting.

👉 https://deploy-preview-11249--material-ui-x.netlify.app/x/react-charts/

Sorry, something went wrong.

@danilo-leal danilo-leal added docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Nov 29, 2023
@alexfauquette
Copy link
Member

alexfauquette commented Nov 30, 2023

A similar effort has already been merged on master and is cherry-picked on next #11239. So some conflict might be expected
🙈

Especially on the nav bar structure, and the introduction page

@danilo-leal
Copy link
Contributor Author

@alexfauquette, should I wait for you to finish/merge that other PR? Any recommendations? 😬

@alexfauquette
Copy link
Member

The other PR is ready to be merged. It's a cherry-pick of another PR that has already been accepted

@danilo-leal
Copy link
Contributor Author

Ok, I'll wait for that and then resolve any conflicts with this one!

Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 30, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 30, 2023
@danilo-leal
Copy link
Contributor Author

@flaviendelangle + @alexfauquette can y'all take a second look at this when possible? 😃

Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

👌

@danilo-leal danilo-leal merged commit d02cc33 into mui:next Dec 5, 2023
@danilo-leal danilo-leal deleted the charts-docs-general-tweaks branch December 5, 2023 10:40
oliviertassinari added a commit that referenced this pull request Jan 3, 2024

Verified

This commit was signed with the committer’s verified signature.
oliviertassinari Olivier Tassinari
A quick fix on top of #11249.
title: 'Bar Chart',
srcLight: '/static/x/component-illustrations/bar-light.png',
srcDark: '/static/x/component-illustrations/bar-dark.png',
href: '/x/react-charts/bar/',
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you!

oliviertassinari pushed a commit that referenced this pull request Jan 5, 2024

Verified

This commit was signed with the committer’s verified signature.
oliviertassinari Olivier Tassinari
oliviertassinari added a commit that referenced this pull request Jan 5, 2024

Verified

This commit was signed with the committer’s verified signature.
oliviertassinari Olivier Tassinari
A quick fix on top of #11249.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: charts This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants