Skip to content

Conversation

@oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Apr 15, 2025

Remove ad on paid docs pages, and fix some small docs issues along the way.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation. label Apr 15, 2025
@mui-bot
Copy link

mui-bot commented Apr 15, 2025

@oliviertassinari oliviertassinari added the type: bug It doesn't behave as expected. label Apr 15, 2025
@@ -1,5 +1,5 @@
---
title: Charts - Zooming and panning
title: Charts - Zoom and pan
Copy link
Member Author

Choose a reason for hiding this comment

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

To match the link in the sidenav

---

# Data Grid - Columns Panel 🚧
# Data Grid - Columns panel 🚧
Copy link
Member Author

Choose a reason for hiding this comment

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

Sentence case seem to apply here

Copy link
Member

Choose a reason for hiding this comment

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

What's the reason for the change? We are referring to the component name here which is Columns Panel.

Copy link
Member Author

Choose a reason for hiding this comment

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

The default is sentence case, I didn't understand why it uses title case, so went back to the default.

Copy link
Member Author

@oliviertassinari oliviertassinari Apr 15, 2025

Choose a reason for hiding this comment

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

I'm reverting this though, for the sake of having smaller more focused PRs. (not the title, I don't see how the title can be correct, but the changes in the body)

Copy link
Member

Choose a reason for hiding this comment

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

not the title, I don't see how the title can be correct

It is consistent with other docs pages where we refer to the component name, for example:

Screenshot 2025-04-15 at 19 53 29

Copy link
Member Author

@oliviertassinari oliviertassinari Apr 15, 2025

Choose a reason for hiding this comment

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

I think the difference is that

  • "Date Time" is a reference to our date time component to disambiguate with a date time component that people already know. "Column Panel" is not a component that people already know.
  • "Date Time" is a reference to a product, assuming we define product as something that people can use on its own.

Copy link
Member

Choose a reason for hiding this comment

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

"Date Time" is a reference to our date time component to disambiguate with a date time component that people already know. "Column Panel" is not a component that people already know.

I'm not sure I understand this logic — I don't see why it would make a difference whether people know it or not.

"Columns Panel" is consistent with our convention for component naming.

Maybe @mapache-salvaje can help us with the correct casing here? 😅

Copy link
Contributor

@mapache-salvaje mapache-salvaje Apr 17, 2025

Choose a reason for hiding this comment

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

According to our style conventions all MUI components should be treated as proper nouns (aka "Title Case") so "Columns Panel" is correct.

Copy link
Member Author

@oliviertassinari oliviertassinari Apr 17, 2025

Choose a reason for hiding this comment

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

I don't see why it would make a difference whether people know it or not

@kenanyusuf How I understand each:

Date Picker = https://mui.com/x/react-date-pickers/date-picker/
DatePicker or <DatePicker> = https://mui.com/x/api/date-pickers/date-picker/
date picker = https://en.wikipedia.org/wiki/Date_picker

In this case,

Columns Panel = doesn't exist.
ColumnsPanel = doesn't exist, ColumnsPanelTrigger exists
columns panel = https://mui.com/x/react-data-grid/components/columns-panel/

According to our style conventions all MUI components should be treated as proper nouns (aka "Title Case") so "Columns Panel" is correct.

@mapache-salvaje By following https://www.notion.so/mui-org/Style-conventions-for-MUI-components-and-products-dff7d2d7d1ba4a4abd47f48cf345b800 I land on this:

-# Data Grid - Columns Panel 🚧
+# Data Grid - Columns panel 🚧 // none of case 1, 2, 3 applies, so it's default to sentence case)

-### Columns Panel Trigger
+### <ColumnsPanelTrigger> (case 3 applies, but it's a header so no backtick)

`<ColumnsPanelTrigger />` is a button that opens and closes the columns panel.
It renders the `baseButton` slot.

but I have reverted this, to keep the PR focused.

Comment on lines -9 to +10
# Rich Tree View - Lazy loading
# Rich Tree View - Lazy loading [<span class="plan-pro"></span>](/x/introduction/licensing/#pro-plan 'Pro plan')
Copy link
Member Author

Choose a reason for hiding this comment

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

This is Pro


export default function Page() {
return <MarkdownDocs {...pageProps} />;
return <MarkdownDocs disableAd {...pageProps} />;
Copy link
Member Author

Choose a reason for hiding this comment

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


export default function Page() {
return <MarkdownDocs {...pageProps} />;
return <MarkdownDocs disableAd {...pageProps} />;
Copy link
Member Author

Choose a reason for hiding this comment

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


export default function Page() {
return <MarkdownDocs {...pageProps} />;
return <MarkdownDocs disableAd {...pageProps} />;
Copy link
Member Author

Choose a reason for hiding this comment

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

@github-actions
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 Apr 15, 2025
@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Apr 15, 2025
@github-actions
Copy link

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

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Apr 17, 2025
@oliviertassinari oliviertassinari merged commit 7cfbcc6 into mui:master Apr 22, 2025
21 checks passed
@oliviertassinari oliviertassinari deleted the fix-ad-display branch April 22, 2025 13:55
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. type: bug It doesn't behave as expected.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants