Skip to content

[docs] Divide charts tooltip and highlighting pages#14824

Merged
JCQuintas merged 8 commits intomui:masterfrom
JCQuintas:docs-divide-tooltip-and-highlighting
Oct 8, 2024
Merged

[docs] Divide charts tooltip and highlighting pages#14824
JCQuintas merged 8 commits intomui:masterfrom
JCQuintas:docs-divide-tooltip-and-highlighting

Conversation

@JCQuintas
Copy link
Copy Markdown
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. scope: charts Changes related to the charts. labels Oct 4, 2024
@JCQuintas JCQuintas self-assigned this Oct 4, 2024
@mui-bot
Copy link
Copy Markdown

mui-bot commented Oct 4, 2024

@codspeed-hq
Copy link
Copy Markdown

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
Copy Markdown
Contributor

@mapache-salvaje mapache-salvaje 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 👍

Comment thread docs/data/charts/zoom-and-pan/zoom-and-pan.md Outdated
Comment thread docs/data/charts/zoom-and-pan/zoom-and-pan.md Outdated
Copy link
Copy Markdown
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. 👌

Comment thread docs/data/charts/highlighting/Formatting.tsx Outdated
Comment thread docs/data/charts/highlighting/highlighting.md Outdated
Comment thread docs/data/charts/highlighting/highlighting.md Outdated
Comment thread docs/data/charts/highlighting/highlighting.md Outdated
Comment thread docs/data/charts/highlighting/highlighting.md Outdated
Comment thread docs/data/charts/zoom-and-pan/zoom-and-pan.md
Comment thread docs/data/pages.ts Outdated
JCQuintas and others added 3 commits October 8, 2024 14:29
Co-authored-by: Lukas Tyla <llukas.tyla@gmail.com>
Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Comment thread docs/data/pages.ts Outdated
* 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
Copy Markdown
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

docs Improvements or additions to the documentation. scope: charts Changes related to the charts.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants