search

Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
23.35k stars 2.29k forks source link

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

Closed maxkrumpe closed 5 months ago

maxkrumpe commented 5 months ago

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 https://github.com/Redocly/redoc/issues/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

maxkrumpe commented 5 months ago

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

maxkrumpe commented 5 months ago

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

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

AlexVarchuk commented 5 months ago

@maxkrumpe please merge your PR when you are ready.

maxkrumpe commented 5 months ago

@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 commented 5 months ago

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

maxkrumpe commented 5 months ago

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