Skip to content

Commit 4750dd4

Browse files
devGregAclaude
andcommitted
Refine docs site: title-case nav, version-toggle dashboard images, dark mode logo fix
- Title case top navigation menu items (Get Started, Import Data, etc.) - Add version-toggled dashboard images on About and Dashboard pages - Hide Pro-versioned content by default via CSS - Fix version toggle to use display:block instead of empty string - Update dark mode logo SVG fill color for visibility Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 2cf6b5e commit 4750dd4

6 files changed

Lines changed: 48 additions & 24 deletions

File tree

docs/assets/js/custom.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
console.log("[VersionToggle] Setting version to:", version);
1212

1313
document.querySelectorAll(".version-opensource, .version-pro").forEach(el => {
14-
el.style.display = el.classList.contains(`version-${version}`) ? "" : "none";
14+
el.style.display = el.classList.contains(`version-${version}`) ? "block" : "none";
1515
});
1616

1717
localStorage.setItem("version", version);

docs/assets/scss/common/_custom.scss

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,12 @@ h1, h2, h3, h4, h5, h6,
180180
color: white;
181181
}
182182

183+
// Hide Pro-versioned content by default (opensource is default).
184+
// JS sets explicit inline display:block/none when version is toggled.
185+
.version-pro {
186+
display: none;
187+
}
188+
183189
// ============================================================
184190
// Cards
185191
// ============================================================

docs/config/_default/menus/menus.en.toml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
[[main]]
2-
name = "Get started"
2+
name = "Get Started"
33
url = "/get_started/about/about_defectdojo"
44
weight = 10
55

66
[[main]]
7-
name = "Import data"
7+
name = "Import Data"
88
url = "/import_data/import_intro/comparison/"
99
weight = 12
1010

1111
[[main]]
12-
name = "Triage findings"
12+
name = "Triage Findings"
1313
url = "/triage_findings/findings_workflows/intro_to_findings/"
1414
weight = 12
1515

1616
[[main]]
17-
name = "Model your assets"
17+
name = "Model Your Assets"
1818
url = "/asset_modelling/hierarchy/pro__assets_organizations/"
1919
weight = 13
2020

2121
[[main]]
22-
name = "Metrics & reports"
22+
name = "Metrics & Reports"
2323
url = "/metrics_reports/dashboards/introduction_dashboard/"
2424
weight = 14
2525

@@ -29,7 +29,7 @@
2929
weight = 16
3030

3131
[[main]]
32-
name = "Issue tracking"
32+
name = "Issue Tracking"
3333
url = "/issue_tracking/intro/intro/"
3434
weight = 15
3535

@@ -39,7 +39,7 @@
3939
weight = 15
4040

4141
[[main]]
42-
name = "Supported tools"
42+
name = "Supported Tools"
4343
url = "/supported_tools/"
4444
weight = 16
4545

docs/content/get_started/about/about_defectdojo.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,17 @@ weight: 1
77
aliases:
88
- /en/about_defectdojo/about_docs
99
---
10+
<div class="version-opensource">
11+
1012
![image](images/dashboard.png)
1113

14+
</div>
15+
<div class="version-pro">
16+
17+
![image](images/Introduction_to_Dashboard_Features.png)
18+
19+
</div>
20+
1221

1322
<span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Inc. and open-source contributors maintain this documentation to support both the Community and Pro editions of DefectDojo.</span>
1423

docs/content/metrics_reports/dashboards/Introduction_dashboard.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,17 @@ aliases:
88
---
99
The Dashboard is likely the first page you'll see when you open DefectDojo. It summarizes your team’s performance, and provides tracking tools to monitor specific areas of your vulnerability tracking environment.
1010

11+
<div class="version-opensource">
12+
13+
![image](images/dashboard.png)
14+
15+
</div>
16+
<div class="version-pro">
17+
1118
![image](images/Introduction_to_Dashboard_Features.png)
1219

20+
</div>
21+
1322
## Dashboard Components
1423

1524
* **Customizable Dashboard Tiles**, which you can use to visualize the metrics which are relevant to you.

docs/static/svgs/logo-darkmode.svg

Lines changed: 16 additions & 16 deletions
Loading

0 commit comments

Comments
 (0)