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

[Doc] Refactor Theming documentation #9193

Merged
merged 4 commits into from
Aug 18, 2023
Merged

[Doc] Refactor Theming documentation #9193

merged 4 commits into from
Aug 18, 2023

Conversation

fzaninotto
Copy link
Member

@fzaninotto fzaninotto commented Aug 17, 2023

Problems

  • Developers have to read the MUI doc about theming to learn react-admin styling
  • The Theming documentation repeats tips found in other chapters, except that it's outdated and the other chapters are up to date

Solution

A dedicated Theming doc section with several chapters.

image

To do

  • Split the Theming chapter into smaller chapters
  • Add screenshots
  • Update old links to the Theming chapter

<TrueIcon
data-testid="true"
fontSize="small"
className={classes.trueIcon}
Copy link
Member Author

@fzaninotto fzaninotto Aug 17, 2023

Choose a reason for hiding this comment

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

This unrelated change was necessary for an example in the SX documentation

Copy link
Member Author

Choose a reason for hiding this comment

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

These changes fix the TOC, which was too small once readers scroll down on a page and hide the app bar.


## `sx`: Overriding A Component Style
Copy link
Member Author

Choose a reason for hiding this comment

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

All removed sections are present elsewhere. I checked ;)


## Loading
Copy link
Member Author

Choose a reason for hiding this comment

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

Except Loading and LinearProgress, which were poorly documente anyway

docs/Admin.md Outdated Show resolved Hide resolved
docs/AppTheme.md Outdated Show resolved Hide resolved
docs/Authentication.md Outdated Show resolved Hide resolved
docs/BoxStackGrid.md Outdated Show resolved Hide resolved
docs/AppBar.md Outdated Show resolved Hide resolved
docs/AppBar.md Show resolved Hide resolved
docs/Authentication.md Outdated Show resolved Hide resolved
docs/Authentication.md Outdated Show resolved Hide resolved
docs/Layout.md Outdated Show resolved Hide resolved
docs/Theming.md Outdated Show resolved Hide resolved
docs/Theming.md Outdated Show resolved Hide resolved
docs/Theming.md Outdated Show resolved Hide resolved
docs/Theming.md Outdated Show resolved Hide resolved
docs/Theming.md Outdated Show resolved Hide resolved
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: adrien guernier <adrien@marmelab.com>
docs/AppTheme.md Show resolved Hide resolved
docs/SX.md Show resolved Hide resolved
docs/SX.md Outdated Show resolved Hide resolved
Co-authored-by: adrien guernier <adrien@marmelab.com>
Copy link
Collaborator

@djhi djhi left a comment

Choose a reason for hiding this comment

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

Very nice !

@djhi djhi added this to the 4.13.1 milestone Aug 18, 2023
@djhi djhi merged commit 2d6a198 into master Aug 18, 2023
8 checks passed
@djhi djhi deleted the theming-doc branch August 18, 2023 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFR Ready For Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants