Skip to content

Commit d7d05af

Browse files
authored
Merge pull request #44 from chmodshubham/main
Enhance styling and structure across documentation
2 parents c8dadff + 425e646 commit d7d05af

9 files changed

Lines changed: 312 additions & 264 deletions

File tree

.sphinx/_static/custom.css

Lines changed: 252 additions & 214 deletions
Large diffs are not rendered by default.

.sphinx/_static/header.css

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
}
55

66
.p-navigation__nav {
7-
background: linear-gradient(135deg, #6B9BD1 0%, #4A90E2 100%);
7+
background: #1b3a5f;
88
display: flex;
99
font-family: var(--font-stack);
1010
padding: 0.05rem 0;
@@ -81,7 +81,7 @@ ul.p-navigation__links li a {
8181
position: relative;
8282
text-align: left;
8383
text-overflow: ellipsis;
84-
transition-duration: .1s;
84+
transition-duration: 0.1s;
8585
transition-property: background-color, color, opacity;
8686
transition-timing-function: cubic-bezier(0.215, 0.61, 0.355, 1);
8787
white-space: nowrap;
@@ -110,7 +110,7 @@ ul.p-navigation__links .p-dropdown__link:hover {
110110

111111
ul.p-navigation__links .p-navigation__sub-link {
112112
background: var(--color-background-primary);
113-
padding: .5rem 0 .5rem .5rem;
113+
padding: 0.5rem 0 0.5rem 0.5rem;
114114
font-weight: 300;
115115
}
116116

@@ -196,4 +196,4 @@ ul.more-links-dropdown {
196196
ul.p-navigation__links {
197197
margin-left: calc(50% - 41em);
198198
}
199-
}
199+
}

.sphinx/_static/ngkore-theme.css

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@
4545
font-weight: 600;
4646
}
4747

48-
/* Style buttons and interactive elements */
48+
/* Style buttons and interactive elements - exclude UI control buttons */
4949
.btn,
50-
button,
50+
button:not(.copybtn):not(.theme-toggle-icon):not(.back-to-top):not(.sidebar-toggle):not([aria-label]):not(.sphinx-tabs-tab),
5151
input[type="submit"] {
5252
background: linear-gradient(
5353
135deg,
@@ -96,49 +96,38 @@ table.docutils {
9696
}
9797

9898
table.docutils th {
99-
background: linear-gradient(
100-
135deg,
101-
var(--ngkore-primary),
102-
var(--ngkore-secondary)
103-
);
99+
background: var(--ngkore-primary);
104100
color: white;
105101
}
106102

107103
/* Keep original navigation breadcrumbs styling */
108104

109-
/* Style back to top button */
105+
/* Style back to top button - transparent */
110106
.back-to-top {
111-
background: white;
112-
color: var(--ngkore-bg-primary);
113-
border-radius: 40%;
107+
background: transparent !important;
108+
color: var(--color-foreground-secondary);
109+
border-radius: 50%;
114110
transition: all 0.3s ease;
115-
/* align-items: center; */
111+
border: 1px solid rgba(0, 0, 0, 0.1);
116112
}
117113

118114
.back-to-top:hover {
119-
background: white;
120-
color: var(--ngkore-bg-primary);
121-
/* transform: scale(1.05); */
115+
background: rgba(0, 0, 0, 0.05) !important;
116+
color: var(--color-foreground-primary);
117+
border-color: rgba(0, 0, 0, 0.2);
122118
}
123119

124120
/* Dark theme support for back to top button */
125121
body[data-theme="dark"] .back-to-top {
126-
background: linear-gradient(
127-
135deg,
128-
var(--ngkore-primary),
129-
var(--ngkore-secondary)
130-
);
131-
color: white;
122+
background: transparent !important;
123+
color: var(--color-foreground-secondary);
124+
border: 1px solid rgba(255, 255, 255, 0.1);
132125
}
133126

134127
body[data-theme="dark"] .back-to-top:hover {
135-
background: linear-gradient(
136-
135deg,
137-
var(--ngkore-secondary),
138-
var(--ngkore-primary)
139-
);
140-
color: white;
141-
/* transform: scale(1.05); */
128+
background: rgba(255, 255, 255, 0.05) !important;
129+
color: var(--color-foreground-primary);
130+
border-color: rgba(255, 255, 255, 0.2);
142131
}
143132

144133
/* Style theme toggle button */

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@
127127

128128
html_css_files = [
129129
'custom.css',
130+
'header.css',
130131
'github_issue_links.css',
131132
'furo_colors.css',
132133
'bottom-logo.css'

index.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,47 @@
11
# NgKore Documentation
22

3-
NgKore (_ngkorefoundation.org_) is an open-source community driving innovation across Post-Quantum Cryptography (PQC), eBPF, 5G Advanced, 6G, O-RAN, NTN, AI/ML, Blockchain, Quantum technologies, and Cloud-Native Architectures.
3+
## Overview
44

5-
## Focus Areas
5+
NgKore Foundation (_ngkorefoundation.org_) is an open-source community advancing research and development in next-generation network infrastructure, quantum-resistant cryptography, and cloud-native architectures. The foundation focuses on bridging academic research with production-ready implementations across telecommunications, distributed systems, and emerging network technologies.
66

7-
**Core Technologies**
7+
## Technical Domains
88

9-
- {doc}`5G Core Networks <5g-core/index>` - Next-generation mobile networks
10-
- {doc}`O-RAN Interoperability <oran/index>` - Open radio access networks
9+
### Network Infrastructure
1110

12-
**Security & Cryptography**
11+
{doc}`5G Core Networks <5g-core/index>`
12+
: Standards-compliant 5G core network implementations, service-based architecture, and network function virtualization.
1313

14-
- {doc}`Post-Quantum Cryptography <pqc/index>` - Future-proof encryption
15-
- {doc}`Network Security <security/index>` - Advanced protection mechanisms
14+
{doc}`O-RAN Interoperability <oran/index>`
15+
: Open radio access network specifications, intelligent RAN controllers, and vendor-neutral interfaces.
1616

17-
**Emerging Technologies**
17+
{doc}`Non-Terrestrial Networks <ntn/index>`
18+
: Satellite communications, aerial connectivity platforms, and hybrid terrestrial-non-terrestrial network architectures.
1819

19-
- {doc}`AI/ML Integration <ai-ml/index>` - Intelligent network automation
20-
- {doc}`Non-Terrestrial Networks <ntn/index>` - Satellite and aerial connectivity
20+
### Security & Cryptography
2121

22-
**Tools & Orchestration**
22+
{doc}`Post-Quantum Cryptography <pqc/index>`
23+
: Quantum-resistant algorithms, lattice-based cryptography, and migration strategies for post-quantum security.
2324

24-
- {doc}`eBPF Technology & Tools <ebpf/index>` - High-performance packet processing
25-
- {doc}`Kernel Bypass Technologies <kernel-bypass/index>` - Ultra-low latency networking
25+
{doc}`Network Security <security/index>`
26+
: Advanced threat detection, zero-trust architectures, and secure network function implementations.
27+
28+
### Performance & Optimization
29+
30+
{doc}`eBPF Technology & Tools <ebpf/index>`
31+
: Extended Berkeley Packet Filter for programmable packet processing, observability, and security enforcement.
32+
33+
{doc}`Kernel Bypass Technologies <kernel-bypass/index>`
34+
: DPDK, XDP, and user-space networking for ultra-low latency data plane operations.
35+
36+
### Intelligent Systems
37+
38+
{doc}`AI/ML Integration <ai-ml/index>`
39+
: Machine learning for network optimization, predictive analytics, and autonomous network management.
40+
41+
### Practical Implementation
42+
43+
{doc}`Tutorials <tutorials/index>`
44+
: Step-by-step deployment guides, integration examples, and reference architectures.
2645

2746
---
2847

ntn/oai/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
66
introduction-to-ntn
77
oai-ntn
8-
```
8+
../../tutorials/oai/oai-nr-5g-ntn
9+
```

tutorials/osc-oam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The deployment may take time as it pulls several large images. Open a separate t
163163
kubectl get pods -A
164164
```
165165

166-
```bash
166+
```console
167167
ubuntu@ubuntu:~/o1-adapter$ kubectl get pods -A
168168
NAMESPACE          NAME                                                READY   STATUS      RESTARTS       AGE
169169
cert-manager       cert-manager-5bd57786d4-vcdxb                       1/1     Running     0              3h32m

tutorials/srsran/srsran-f1ap-split.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The deployment follows a **3GPP-aligned CU/DU architecture** and is suitable for
2525

2626
## High-Level Architecture
2727

28-
```
28+
```console
2929
+-----------------------------+
3030
| VM 1 |
3131
| |

tutorials/srsran/srsran-open5gs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This setup is intended for **testing, learning, and research**, and runs entirel
2424

2525
## Architecture Overview
2626

27-
```
27+
```console
2828
+-----------------------------+
2929
| Ubuntu 22.04 VM |
3030
| |

0 commit comments

Comments
 (0)