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] Copyedit pages.ts navigation #14782

Merged
merged 2 commits into from
Oct 1, 2024

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Sep 30, 2024

related to: #2904 (comment)

  • renamed "Advanced" to "Custom behavior"
  • enforced sentence case across all titles
  • removed ampersands
  • shortened "Custom slots and subcomponents" to "Custom subcomponents"
  • removed "Group and Pivot" group to expose more Premium features

@samuelsycamore samuelsycamore added the docs Improvements or additions to the documentation label Sep 30, 2024
@samuelsycamore samuelsycamore marked this pull request as ready for review September 30, 2024 21:42
@mui-bot
Copy link

mui-bot commented Sep 30, 2024

Deploy preview: https://deploy-preview-14782--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 39b8c08

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.

If you feel that slots and part doesn't bring any clarity, I'm fine with it. 👌
But if we rename a menu item, shouldn't we also align that page heading as well? 🤔

I'd ask for a pair of eyes from @mui/xgrid given that most renaming impacts their links.

@flaviendelangle
Copy link
Member

shortened "Custom slots and subcomponents" to "Custom subcomponents"

The main goal was to improve the searchability of this section.
slots is the name of the prop and the name of the technical concept.

If we remove it from the sidebar, then I think it should at least be kept on the page title so that Algolia is able to find this page when searching for slots

Copy link
Member

@cherniavskii cherniavskii left a comment

Choose a reason for hiding this comment

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

Thanks!

docs/data/pages.ts Outdated Show resolved Hide resolved
@samuelsycamore
Copy link
Contributor Author

If we remove it from the sidebar, then I think it should at least be kept on the page title so that Algolia is able to find this page when searching for slots

This makes sense to me. The navbar change is more about aesthetics than anything else, but as long as the page is still discoverable via search then we should be good.

@samuelsycamore
Copy link
Contributor Author

As I spend more time with the X nav bar, I'm starting to feel like the Data Grid navigation could use more structure in the form of subheaders to group different categories of docs (for example, AG Grid has "Core Features," "Advanced Features," and "Miscellaneous"), but that's beyond the scope of the changes here. I'll follow up with another PR to explore this.

Screenshot 2024-10-01 at 10 25 09 AM

@samuelsycamore samuelsycamore merged commit df8ee29 into mui:master Oct 1, 2024
18 checks passed
@flaviendelangle
Copy link
Member

As I spend more time with the X nav bar, I'm starting to feel like the Data Grid navigation could use more structure in the form of subheaders to group different categories of docs (for example, AG Grid has "Core Features," "Advanced Features," and "Miscellaneous")

I agree that grouping pages like we are doing on the pickers can be a nice middle ground between a collapsed folder and a totally flat structure.

Just be careful, last time I tried, when you have a group and then a page below, the page below looks like its in the group, we should probably improve the padding to show that its outside of it.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants