DOP-4967: Contextualize headings in method selector for "On This Page" list #1237
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
mayaraman19
changed the title
rayangler
reviewed
Sep 16, 2024
rayangler
reviewed
Sep 19, 2024
❌ Deploy Preview for mongodb-snooty failed. Why did it fail? →
|
rayangler
approved these changes
Sep 20, 2024
| @@ -68,7 +68,8 @@ const Collapsible = ({ nodeData: { children, options }, ...rest }) => { | |||
| <Box className={cx('collapsible', collapsibleStyle)}> | |||
| <Box className={cx(headerContainerStyle)}> | |||
| <Box> | |||
| <Heading className={cx(headerStyle)} sectionDepth={2} nodeData={headingNodeData}> | |||
| {/* Adding 1 to reflect logic in parser, but want to show up as H2 for SEO reasons */} | |||
There was a problem hiding this comment.
Thank you for this comment! I was a bit confused why we would want to render as an h2 with h3 styling if a writer is placing it under an h2 😕
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.
Stories/Links:
DOP-4967
Update headings to show up when relevant method option is selected. Also, updated collapsible headings to reflect their section depth (i.e. if collapsible is nested it won't have h2 styling)
Current Behavior:
Current method selector behavior
Staging Links:
Staging (content depth 2) - check out collapsible as well
Staging - content depth 1
Non-nested collapsible
Notes:
To test, ensure that the correct headings show up when selecting different methods on the method selector, and also make sure that they reflect where you are on the page (i.e. bolded) and that clicking different headings takes you to the correct spot on the page. Also check out some other pages to ensure their behavior is unchanged.
README updates