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] Revise the Bar and Gauge docs and begin standardizing Chart doc structure #16500

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

mapache-salvaje
Copy link
Contributor

@mapache-salvaje mapache-salvaje commented Feb 6, 2025

When users make their way over to the Charts from Material UI, there should be a consistent, predictable, and more or less seamless experience.

This PR revamps the content and the structure of the Bar and Gauge component pages to better align with the current standards for Material UI demo pages—for examples, see:

The Overview / Demos pattern feels strange to me, and doesn't match up with the patterns for any other products. I propose merging the Demos into the Overview pages and renaming them "Common examples" as we've done in Joy UI docs.

We can use this PR to align on what may work best for the Charts as a whole, and then I'll apply the final pattern here to the rest of the pages in a follow-up.

Here's the template I'm starting from:

## Introduction

Brief explanation of what it is and how it works.

### Usage (optional)

If necessary, compare and contrast with other similar components that may (seemingly) have overlapping use cases.

## Basics

Component import for easy copy-pasting; optionally, further details on how to set it up.

### {{ Basic features }}

h3s under Basics describe how to use built-in props.

## Customization

### {{ Other common use cases }}

h3s under Customization describe how to implement other common use cases that go beyond built-in props.

## Composition

Subcomponent imports; details on how to compose your own custom version of the component.

## Common examples (optional)

### {{ Real-world-ish use case }}

h3s under Common examples describe use cases that are closer to the real world and are focused on demos.

## Accessibility

### {{ A11y guidance }}

h3s under Accessibility describe individual requirements and best practices.

@mapache-salvaje mapache-salvaje added docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature component: charts This is the name of the generic UI component, not the React module! labels Feb 6, 2025
@mui-bot
Copy link

mui-bot commented Feb 6, 2025

Copy link

codspeed-hq bot commented Feb 6, 2025

CodSpeed Performance Report

Merging #16500 will not alter performance

Comparing mapache-salvaje:charts-editing (b2b937b) with master (1ffe360)

Summary

✅ 6 untouched benchmarks

@mapache-salvaje mapache-salvaje changed the title [docs][charts] Revise the Gauge doc and begin standardizing Chart doc structure [docs][charts] Revise the Bar and Gauge docs and begin standardizing Chart doc structure Feb 6, 2025
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 7, 2025
Copy link

github-actions bot commented Feb 7, 2025

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

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 enhancement This is not a bug, nor a new feature PR: out-of-date The pull request has merge conflicts and can't be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants