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

[Doc] Add beginner mode to hide advanced doc chapters #9306

Merged
merged 4 commits into from
Sep 26, 2023
Merged

[Doc] Add beginner mode to hide advanced doc chapters #9306

merged 4 commits into from
Sep 26, 2023

Conversation

fzaninotto
Copy link
Member

@fzaninotto fzaninotto commented Sep 23, 2023 •
edited
Loading

Problem

React-admin is a large framework, and its doc may be overwhelming for beginners

Solution

  • Display a button allowing to hide advanced doc chapters
  • Mention this beginner mode in the tutorial
beginner-mode.mp4

@fzaninotto fzaninotto added the WIP Work In Progress label Sep 23, 2023
slax57
slax57 reviewed Sep 25, 2023
View reviewed changes
Copy link
Contributor

@slax57 slax57 left a comment

Choose a reason for hiding this comment

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

One last comment: I believe the UI for the checkbox is not particularly beautiful, and does not fit very well with the current design.

image

A bit of CSS might be welcome 🙂

docs/navigation.html Outdated Show resolved Hide resolved
docs/navigation.html Outdated Show resolved Hide resolved
docs/navigation.html Outdated Show resolved Hide resolved
@fzaninotto fzaninotto added RFR Ready For Review and removed WIP Work In Progress labels Sep 26, 2023
slax57
slax57 reviewed Sep 26, 2023
View reviewed changes
Copy link
Contributor

@slax57 slax57 left a comment

Choose a reason for hiding this comment

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

Works nice, well done!

However, I'm still not really found of the color of the switch

image

Can't you make it more in the tones of the rest of the documentation's theme?

@fzaninotto
Copy link
Member Author

fzaninotto commented Sep 26, 2023 •
edited
Loading

Can't you make it more in the tones of the rest of the documentation's theme?

Yep, done.

image

slax57
slax57 requested changes Sep 26, 2023
View reviewed changes
docs/css/style-v18.css Show resolved Hide resolved
@slax57 slax57 added this to the 4.14.4 milestone Sep 26, 2023
@slax57 slax57 merged commit 98ae9a4 into master Sep 26, 2023
@slax57 slax57 deleted the doc-beginner-mode branch September 26, 2023 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@djhi djhi djhi approved these changes

@slax57 slax57 slax57 approved these changes

Assignees
No one assigned
Labels
RFR Ready For Review
Projects
None yet
Milestone
4.14.4
Development

Successfully merging this pull request may close these issues.
3 participants
@fzaninotto @djhi @slax57