Skip to content

Commit ce38392

Browse files
authored
fix: heading hierachy for the docs pages (#165)
* fix: heading hierachy for the docs pages * fix: duplicate meta description
1 parent fdde873 commit ce38392

File tree

5 files changed

+15
-17
lines changed

5 files changed

+15
-17
lines changed

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Documentation
1+
site_name: OpenObserve Documentation
22
site_url: https://openobserve.ai/docs
33
# https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin required for nav
44
plugins:

overrides/css/landing-page.css

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ body > .landing-page {
8383

8484
/* Heading styles */
8585
.landing-page h1 {
86-
font-size: 20px !important;
86+
font-size: 32px !important;
8787
font-weight: bold;
8888
margin: 0;
8989
line-height: 1.3;
@@ -176,6 +176,7 @@ body:has(.landing-page) .md-sidebar--secondary {
176176
margin-bottom: 12px;
177177
position: relative;
178178
overflow: hidden;
179+
margin-top: 20px;
179180
}
180181

181182
/* Dark theme hero card background */

overrides/main.html

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,6 @@
22

33
{% block extrahead %}
44
{{ super() }}
5-
{% block htmltitle %}
6-
<title>OpenObserve Documentation</title>
7-
{% endblock %}
8-
{% if page and page.meta and page.meta.description %}
9-
<meta name="description" content="{{ page.meta.description }}">
10-
{% endif %}
115

126
<!-- Simple theme flash prevention -->
137
<script>

overrides/partials/header.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@
254254
<div
255255
class="flex items-center justify-between text-gray-500 text-base font-semibold w-full text-left toggle-btn"
256256
>
257-
<h4>Platform</h4>
257+
<span>Platform</span>
258258
<img
259259
src="/docs/assets/submenu-icon.svg"
260260
alt="Arrow"
@@ -265,9 +265,9 @@ <h4>Platform</h4>
265265
<div
266266
class="border rounded-md p-4 text-center flex flex-col space-y-2"
267267
>
268-
<h3 class="font-medium text-xs text-black">
268+
<p class="font-medium text-xs text-black">
269269
Full Stack Observability Platform
270-
</h3>
270+
</p>
271271
<a
272272
href="/platform/"
273273
class="text-xs gradient-hover font-medium underline"
@@ -337,7 +337,7 @@ <h3 class="font-medium text-xs text-black">
337337
<div
338338
class="flex items-center justify-between text-gray-500 text-base font-semibold w-full text-left toggle-btn"
339339
>
340-
<h4>Solutions</h4>
340+
<span>Solutions</span>
341341
<img
342342
src="/docs/assets/submenu-icon.svg"
343343
alt="Arrow"
@@ -348,9 +348,9 @@ <h4>Solutions</h4>
348348
<div
349349
class="border rounded-md p-4 text-center flex flex-col space-y-2"
350350
>
351-
<h3 class="font-medium text-xs text-black">
351+
<p class="font-medium text-xs text-black">
352352
Full Stack Observability Solutions
353-
</h3>
353+
</p>
354354
<a
355355
href="/solutions/"
356356
class="text-xs gradient-hover font-medium underline"
@@ -423,7 +423,7 @@ <h3 class="font-medium text-xs text-black">
423423
<div
424424
class="flex items-center justify-between text-gray-500 text-base font-semibold w-full text-left toggle-btn"
425425
>
426-
<h4>Resources</h4>
426+
<span>Resources</span>
427427
<img
428428
src="/docs/assets/submenu-icon.svg"
429429
alt="Arrow"
@@ -432,11 +432,11 @@ <h4>Resources</h4>
432432
</div>
433433
<div class="submenu hidden space-y-4 mt-2">
434434
<div class="border rounded-md p-4 text-center">
435-
<h3
435+
<p
436436
class="font-medium text-xs text-black flex flex-col space-y-2"
437437
>
438438
Full Stack Observability Resources
439-
</h3>
439+
</p>
440440
<a
441441
href="/resources/"
442442
class="text-xs gradient-hover font-medium underline"

overrides/partials/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
<div class="landing-container w-full mx-auto">
77
<!-- Main Content -->
88
<main class="landing-main-content">
9+
<!-- Main Documentation Heading -->
10+
<h1 class="">OpenObserve Documentation</h1>
11+
912
<!-- Hero Card -->
1013
<div class="landing-hero-card">
1114
<div class="landing-hero-content">

0 commit comments

Comments
 (0)