[Doc] Improve the Show section #9423
Merged
+798
−389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adguernier
reviewed
Nov 7, 2023
| @@ -51,13 +51,56 @@ const PostShow = () => { | |||
|
|
|||
| This custom Show view has no action buttons - it's up to you to add them in pure React. | |||
|
|
|||
| **Tip**: Use [`<ShowBase>`](./ShowBase.md) instead of `useShowController` if you need a component version of that hook. | |||
|
|
|||
| ## Parameters | |||
There was a problem hiding this comment.
Suggested change
| ## Parameters | |
| ## Props |
There was a problem hiding this comment.
A hook doesn't have props.
There was a problem hiding this comment.
The header in the parameters table still says "Prop", just saying 🙄 😁
Co-authored-by: adrien guernier <adrien@marmelab.com>
adguernier
approved these changes
Nov 7, 2023
slax57
requested changes
Nov 7, 2023
| @@ -51,13 +51,56 @@ const PostShow = () => { | |||
|
|
|||
| This custom Show view has no action buttons - it's up to you to add them in pure React. | |||
|
|
|||
| **Tip**: Use [`<ShowBase>`](./ShowBase.md) instead of `useShowController` if you need a component version of that hook. | |||
|
|
|||
| ## Parameters | |||
There was a problem hiding this comment.
The header in the parameters table still says "Prop", just saying 🙄 😁
slax57
approved these changes
Nov 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The chapters of the Show section don't list all possible props, have outdated screenshots, and generally don't put the things in the right order
Solution
Rewrite those chapters