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

fix: use h2/h3 for headings instead of h1/h2 for better seo #2514

Merged
merged 4 commits into from
Apr 25, 2024

Conversation

maxkrumpe
Copy link
Contributor

What/Why/How?

Changed headings from h1/h2 to h2/h3 for content items for a better seo behavior.

Because of multiple h1 tags Google will list the pages more bad than with a better structured layout.

Reference

See #2513

Tests

All tests were successfully run (unit tests).
We do not consider issues because only the headings were changed.
Only the look an feel (smaller headings for tags) is a bit different (see screenshot).

Screenshots (optional)

image

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

@maxkrumpe maxkrumpe requested a review from a team as a code owner April 17, 2024 08:17
@maxkrumpe
Copy link
Contributor Author

Hey @RomanHotsiy, would you like to spend some time to review this PR?
I am not sure if I forgot something for this PR :)

Copy link
Collaborator

@AlexVarchuk AlexVarchuk left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@AlexVarchuk AlexVarchuk left a comment

Choose a reason for hiding this comment

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

Please update e2e tests. A couple of them failed in menu.e2e.ts

@maxkrumpe
Copy link
Contributor Author

Please update e2e tests. A couple of them failed in menu.e2e.ts

Thanks for the notifications.
Now the tests are running again :)

@AlexVarchuk
Copy link
Collaborator

@maxkrumpe please merge your PR when you are ready.

@maxkrumpe
Copy link
Contributor Author

@maxkrumpe please merge your PR when you are ready.

@AlexVarchuk I don't have write access to the repository so unfortunately I cannot merge the PR.
image

Do you have write access to it to merge the PR?

@AlexVarchuk AlexVarchuk merged commit 2b72dc0 into Redocly:main Apr 25, 2024
3 checks passed
@AlexVarchuk
Copy link
Collaborator

@maxkrumpe Done. Thank you very much for your contribution. 🙌

@maxkrumpe
Copy link
Contributor Author

@AlexVarchuk thank you too for reviewing the PR.
Do you know when a new version with those changes is planned?

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.

3 participants