From 2b72dc0e90f759a8ee2e47691c844e7f05928a24 Mon Sep 17 00:00:00 2001 From: Max Krumpe <42165374+maxkrumpe@users.noreply.github.com> Date: Thu, 25 Apr 2024 11:46:12 +0200 Subject: [PATCH] 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 --- e2e/integration/menu.e2e.ts | 4 ++-- src/components/ContentItems/ContentItems.tsx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/e2e/integration/menu.e2e.ts b/e2e/integration/menu.e2e.ts index e20a257d..38160fdb 100644 --- a/e2e/integration/menu.e2e.ts +++ b/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') diff --git a/src/components/ContentItems/ContentItems.tsx b/src/components/ContentItems/ContentItems.tsx index 38f40767..18801c62 100644 --- a/src/components/ContentItems/ContentItems.tsx +++ b/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 { render() { const { name, description, externalDocs, level } = this.props.item as GroupModel; - const Header = level === 2 ? H2 : H1; + const Header = level === 2 ? H3 : H2; return ( <>