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] Divide charts tooltip and highlighting pages #14824

Merged

Conversation

JCQuintas
Copy link
Member

  • Remove highlight sections from tooltip page
  • Create new highlighting page for that aspect
  • Small title updates

@JCQuintas JCQuintas added docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Oct 4, 2024
@JCQuintas JCQuintas self-assigned this Oct 4, 2024
Copy link

codspeed-hq bot commented Oct 4, 2024

CodSpeed Performance Report

Merging #14824 will not alter performance

Comparing JCQuintas:docs-divide-tooltip-and-highlighting (a6c20a8) with master (6ce41a1)

Summary

✅ 3 untouched benchmarks

Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

I would like to do line-by-line reviews of both docs in the near future but this looks good for now. Good call on separating them 👍

docs/data/charts/zoom-and-pan/zoom-and-pan.md Outdated Show resolved Hide resolved
docs/data/charts/zoom-and-pan/zoom-and-pan.md Outdated Show resolved Hide resolved
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Great work. 👍
Cleaner result. 👌

docs/data/charts/highlighting/Formatting.tsx Outdated Show resolved Hide resolved
docs/data/charts/highlighting/highlighting.md Outdated Show resolved Hide resolved
docs/data/charts/highlighting/highlighting.md Outdated Show resolved Hide resolved
docs/data/charts/highlighting/highlighting.md Outdated Show resolved Hide resolved
docs/data/charts/highlighting/highlighting.md Outdated Show resolved Hide resolved
docs/data/charts/zoom-and-pan/zoom-and-pan.md Show resolved Hide resolved
docs/data/pages.ts Outdated Show resolved Hide resolved
docs/data/pages.ts Outdated Show resolved Hide resolved
@@ -88,7 +88,7 @@ BarChartPro.propTypes = {
* The configuration of axes highlight.
* Default is set to 'band' in the bar direction.
* Depends on `layout` prop.
* @see See {@link https://mui.com/x/react-charts/tooltip/#highlights highlight docs} for more details.
* @see See {@link https://mui.com/x/react-charts/highlighting highlighting docs} for more details.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* @see See {@link https://mui.com/x/react-charts/highlighting highlighting docs} for more details.
* @see See {@link https://mui.com/x/react-charts/highlighting/ highlighting docs} for more details.

Fixed in 23646d8

A side note, we will move to non-trailing URLs, at one point mui/mui-public#248.

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.

6 participants