[docs] Fix various issues with heading structure #20389
Merged
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
eps1lon
added
docs
Details of bundle changes.Comparing: 7bb8c2c...f5f8f87 Details of page changes
|
| @@ -6,18 +6,18 @@ | |||
|
|
|||
| A function which returns [a class name generator function](https://cssinjs.org/jss-api/#generate-your-class-names). | |||
|
|
|||
| #### Arguments | |||
| ### Arguments | |||
There was a problem hiding this comment.
The motivation was to remove these values from the table of contents to make it easier to navigate. What about?
Suggested change
| ### Arguments | |
| **Arguments** |
There was a problem hiding this comment.
Why do you want them removed from the TOC? There obviously a sub-item of the method.
There was a problem hiding this comment.
What do you think of the difference of experience between
A.
…
more content truncated
B.
Are "Arguments", "Returns", "Example" important enough to be included in the TOCs? It comes with the assumption that the longest the TOCs is, the harder it's to scan and find interesting content.
There was a problem hiding this comment.
On a side note, the change goes against the other header structure in the documentation. So far The #### Arguments level was used exclusively. It would be awesome to uniformized it.
There was a problem hiding this comment.
I am not able to follow. You obviously want to group the content and describe it with a single word. That is a heading. Not sure what we're discussing here.
There was a problem hiding this comment.
It would be awesome to uniformized it.
I was wrong, the header structure in the other pages that have Arguments as a header already have a continuous <hx> structure.
oliviertassinari
approved these changes
Apr 5, 2020
This was referenced Apr 13, 2020
This was referenced Apr 20, 2020
This was referenced May 4, 2020
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.
improve heading structure of landing page
The full strapline is too long for a heading. It also caused installation and usage to be be on the lowest heading level and didn't translate to the visual representation of the landing page
Before:
After:
fixes issues with skipped headings
did not check every page under /components or /api since they're mostly auto-generated. Especially for demos I'm not that concerned with skipped headings. The demo should not be concerned with the context it's embedded in.