Skip to content

[docs] append "pro" and "open source" to article names#14432

Open
paulOsinski wants to merge 1 commit intoDefectDojo:bugfixfrom
paulOsinski:better-versioning
Open

[docs] append "pro" and "open source" to article names#14432
paulOsinski wants to merge 1 commit intoDefectDojo:bugfixfrom
paulOsinski:better-versioning

Conversation

@paulOsinski
Copy link
Contributor

As we continue to version our documentation based on Open Source and Pro content, this feature appends "(Pro)" or "(Open Source)" to the title of articles at build time depending on their "audience" attribute.

This presents much better in the sidebar, as that context should already be implicit from the "DefectDojo Version" menu.

"Pro" and "Open Source" versions of article titles will still appear in search results and the title of articles.

Copy link

@accesslint accesslint bot left a comment

Choose a reason for hiding this comment

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

Found 3 issues across 3 rules (1 WCAG, 2 Best Practice).

{{ if .Params.toc -}}
<main class="docs-content col-lg-11 col-xl-9">
{{ else -}}
<main class="docs-content col-lg-11 col-xl-9 mx-xl-auto">
Copy link

Choose a reason for hiding this comment

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

Best Practice: Page has multiple main landmarks.

Page should have exactly one main landmark.

Details

The main landmark contains the primary content of the page. Screen readers allow users to jump directly to main content. Use a single <main> element (or role='main') to wrap the central content, excluding headers, footers, and navigation.


Best Practice: Page has multiple main landmarks.

Page should not have more than one main landmark.

Details

Only one main landmark should exist per page. The main landmark identifies the primary content area. If you have multiple content sections, use <section> with appropriate headings instead of multiple main elements.

{{ if site.Params.doks.breadcrumbTrail -}}
<!-- https://discourse.gohugo.io/t/breadcrumb-navigation-for-highly-nested-content/27359/6 -->
<nav aria-label="breadcrumb">
<ol class="breadcrumb">
Copy link

Choose a reason for hiding this comment

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

WCAG 1.3.1: <ol> contains direct text content. Wrap in <li>.

<ul> and <ol> must only contain <li>, <script>, or <template> as direct children.

Details

Screen readers announce list structure ('list with 5 items') based on proper markup. Placing non-<li> elements directly inside <ul> or <ol> breaks this structure. Wrap content in <li> elements, or if you need wrapper divs for styling, restructure your CSS to style the <li> elements directly.

@github-actions github-actions bot added the docs label Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant