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.

Sign up for GitHub

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

Jump to bottom

[docs][joy] Improve the Slots Table in API docs #36328

Merged
merged 3 commits into from
Mar 17, 2023
Merged

[docs][joy] Improve the Slots Table in API docs #36328

merged 3 commits into from
Mar 17, 2023

Conversation

hbjORbj
Copy link
Member

@hbjORbj hbjORbj commented Feb 25, 2023 •
edited
Loading

@hbjORbj hbjORbj self-assigned this Feb 25, 2023
@hbjORbj hbjORbj added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Feb 25, 2023
@hbjORbj hbjORbj force-pushed the joy/api-docs-slot-description branch from 3ae042f to 99a923b Compare February 25, 2023 09:16
@mui-bot
Copy link

mui-bot commented Feb 25, 2023 •
edited
Loading

Netlify deploy preview

https://deploy-preview-36328--material-ui.netlify.app/

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against dc80331

@hbjORbj hbjORbj mentioned this pull request Feb 25, 2023
Merged
1 task
@hbjORbj hbjORbj added this to the Joy UI stable release milestone Feb 25, 2023
@hbjORbj
Copy link
Member Author

hbjORbj commented Mar 6, 2023

Followed Sam's suggestion for Joy UI as well

@siriwatknp
Copy link
Member

@hbjORbj Is it possible to have root slot at the top in this section https://deploy-preview-36328--material-ui.netlify.app/joy-ui/api/alert/#slots ?

@hbjORbj hbjORbj force-pushed the joy/api-docs-slot-description branch from 217b5a6 to fa72075 Compare March 15, 2023 10:27
@hbjORbj
Copy link
Member Author

hbjORbj commented Mar 15, 2023 •
edited by oliviertassinari
Loading

Is it possible to have root slot at the top in this section https://deploy-preview-36328--material-ui.netlify.app/joy-ui/api/alert/#slots ?

@siriwatknp Sure I will open a separate PR for this.

@hbjORbj hbjORbj mentioned this pull request Mar 15, 2023
Closed
1 task
@oliviertassinari oliviertassinari mentioned this pull request Mar 15, 2023
Merged
@hbjORbj hbjORbj enabled auto-merge (squash) March 16, 2023 18:16
@hbjORbj hbjORbj disabled auto-merge March 16, 2023 18:16
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 17, 2023
@hbjORbj hbjORbj force-pushed the joy/api-docs-slot-description branch from 052cfb1 to dc80331 Compare March 17, 2023 13:48
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 17, 2023
@hbjORbj hbjORbj merged commit 9cb461b into mui:master Mar 17, 2023
@oliviertassinari
Copy link
Member

I see two things that we can improve:

  1. There is a lot of duplication.

Screenshot 2023-03-20 at 01 10 29

I think that the content would be much better at the top, listed once.

  1. The content it links to only talks about the slots components, but there is nothing about slotsProps or class names.

@siriwatknp siriwatknp mentioned this pull request Mar 20, 2023
Merged
@hbjORbj
Copy link
Member Author

hbjORbj commented Mar 23, 2023 •
edited
Loading

  1. Agree. Handling this in a new PR.
  2. Maybe we need more docs dedicated for slotsProps or class names? cc @samuelsycamore

@hbjORbj hbjORbj mentioned this pull request Mar 23, 2023
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@siriwatknp siriwatknp Awaiting requested review from siriwatknp

Assignees

@hbjORbj hbjORbj

Labels
docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Milestone
Joy UI: Stable release
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@hbjORbj @mui-bot @siriwatknp @oliviertassinari