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

DOP-3848: render H2 component as h1, H3 component as h2 #874

Merged
merged 3 commits into from
Sep 5, 2023

Conversation

mayaraman19
Copy link
Collaborator

@mayaraman19 mayaraman19 commented Aug 30, 2023

Stories/Links:

[DOP-3848](https://jira.mongodb.org/browse/DOP-3848

Current Behavior:

The Changelog page currently renders the title as h2, and the release dates as h3. This PR has changed them to retain the style and keep using the H2 and H3 LeafyGreen components, but they are now rendered as h1 and h2, respectively.

Staging link:

https://docs-mongodb-org-stg.s3.us-east-2.amazonaws.com/master/cloud-docs/maya/dop-3848/reference/api-resources-spec/changelog/

Notes:

There was a bit of confusion between retaining/not retaining the styles of an H1 vs H2 component, or H2 vs H3 component, and I'm still not completely sure what to go with but this is going with retaining the original style of the webpage

@mayaraman19 mayaraman19 changed the title render H2 component as h1, H3 component as h2 DOP-3848: render H2 component as h1, H3 component as h2 Aug 30, 2023
@mayaraman19 mayaraman19 marked this pull request as ready for review August 31, 2023 18:53
Copy link
Collaborator

@mmeigs mmeigs left a comment

Choose a reason for hiding this comment

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

Great! LGTM. I'd love to hear more about the confusion that went around later!

@mayaraman19 mayaraman19 merged commit 89357e1 into master Sep 5, 2023
2 checks passed
@mayaraman19 mayaraman19 deleted the dop-3848 branch September 5, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants