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

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

* fix: fixed e2e tests for changed headings

---------

Co-authored-by: Max Krumpe <[email protected]>

Author: maxkrumpe

e2e/integration/menu.e2e.ts

@@ -8,7 +8,7 @@ describe('Menu', () => {
     });
 
     it('should sync active menu items while scroll', () => {
-      cy.contains('h1', 'Introduction')
+      cy.contains('h2', 'Introduction')
         .scrollIntoView()
         .get('[role=menuitem] > label.active')
         .should('have.text', 'Introduction');
@@ -35,7 +35,7 @@ describe('Menu', () => {
 
       cy.contains('h1', 'Swagger Petstore').scrollIntoView().wait(100);
 
-      cy.contains('h1', 'Introduction')
+      cy.contains('h2', 'Introduction')
         .scrollIntoView()
         .wait(100)
         .get('[role=menuitem] > label.active')

src/components/ContentItems/ContentItems.tsx

@@ -3,7 +3,7 @@ import * as React from 'react';
 
 import { ExternalDocumentation } from '../ExternalDocumentation/ExternalDocumentation';
 import { AdvancedMarkdown } from '../Markdown/AdvancedMarkdown';
-import { H1, H2, MiddlePanel, Row, Section, ShareLink } from '../../common-elements';
+import { H2, H3, MiddlePanel, Row, Section, ShareLink } from '../../common-elements';
 import type { ContentItemModel } from '../../services';
 import type { GroupModel, OperationModel } from '../../services/models';
 import { Operation } from '../Operation/Operation';
@@ -68,7 +68,7 @@ export class SectionItem extends React.Component<ContentItemProps> {
   render() {
     const { name, description, externalDocs, level } = this.props.item as GroupModel;
 
-    const Header = level === 2 ? H2 : H1;
+    const Header = level === 2 ? H3 : H2;
     return (
       <>
         <Row>