maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: replace HTML header with Markdown heading

Browse Source 
- Removed HTML table and font tags for the OAI titles and replaced them with a clean Markdown H1 heading
      - Added missing # H1 headings in some files
This commit is contained in:
Shubhika Garg
2026-01-22 10:55:05 +01:00
parent 5c480ffd50
commit 17c6d0feb2
26 changed files with 33 additions and 261 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/Aerial_FAPI_Split_Tutorial.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI 7.2 Fronthaul Interface 5G SA Tutorial
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI 7.2 Fronthaul Interface 5G SA Tutorial</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/BUILD.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI Build Procedures
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI Build Procedures</font></b>
</td>
</tr>
</table>
[[_TOC_]] [[_TOC_]]
doc/E1AP/e1ap_procedures.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # E1AP Procedures
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">E1AP Procedures</font></b>
</td>
</tr>
</table>
[[_TOC_]] [[_TOC_]]
doc/F1AP/F1-design.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # F1 split design
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="../images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">F1 split design</font></b>
</td>
</tr>
</table>
[[_TOC_]] [[_TOC_]]
doc/F1AP/F1AP-lib.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # F1AP Messages Encoding & Decoding Library
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="../images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">F1AP Messages Encoding & Decoding Library</font></b>
</td>
</tr>
</table>
[[_TOC_]] [[_TOC_]]
doc/FEATURE_SET.md
+2
View File
@@ -1,3 +1,5 @@
# Feature Set
**Table of Contents** **Table of Contents**
[[_TOC_]] [[_TOC_]]
doc/L1SIM.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # Open Air LTE Emulation
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">Open Air LTE Emulation</font></b>
</td>
</tr>
</table>
> **Note: Unless you know what you are doing, you likely do not need this!** > **Note: Unless you know what you are doing, you likely do not need this!**
Rather, you are probably looking for the Rather, you are probably looking for the
doc/L2NFAPI.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # L2 nFAPI Simulator Usage
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">L2 nFAPI Simulator Usage</font></b>
</td>
</tr>
</table>
## 4G L2 nFAPI simulator ## 4G L2 nFAPI simulator
doc/L2NFAPI_NOS1.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # L2 nFAPI Simulator (no S1 Mode / 2-host deployment)
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">L2 nFAPI Simulator (no S1 Mode / 2-host deployment)</font></b>
</td>
</tr>
</table>
> **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.** > **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
doc/L2NFAPI_S1.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # L2 nFAPI Simulator (with S1 / 2-host deployment)
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">L2 nFAPI Simulator (with S1 / 2-host deployment)</font></b>
</td>
</tr>
</table>
> **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.** > **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
doc/LDPC_OFFLOAD_SETUP.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI LDPC offload (O-RAN AAL/DPDK BBDEV)
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI LDPC offload (O-RAN AAL/DPDK BBDEV)</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/NR_NFAPI_archi.md
+2
View File
@@ -1,3 +1,5 @@
# SmallCellForum 5G (n)FAPI split
This document describes the broad way in which the VNF and PNF work internally, This document describes the broad way in which the VNF and PNF work internally,
from configuration, to P5 and P7 message exchange and processing. from configuration, to P5 and P7 message exchange and processing.
Their internal processing is broadly independent on which transport mechanism Their internal processing is broadly independent on which transport mechanism
doc/NR_SA_Tutorial_COTS_UE.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI 5G NR SA tutorial with COTS UE
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI 5G NR SA tutorial with COTS UE</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/NR_SA_Tutorial_OAI_CN5G.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI 5G NR SA tutorial: setting up OAI CN5G
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI 5G NR SA tutorial: setting up OAI CN5G</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/NR_SA_Tutorial_OAI_multi_UE.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI 5G NR SA tutorial to deploy multiple OAI nrUE
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI 5G NR SA tutorial to deploy multiple OAI nrUE</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/NR_SA_Tutorial_OAI_nrUE.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI 5G NR SA tutorial with OAI nrUE
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI 5G NR SA tutorial with OAI nrUE</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/ORAN_FHI7.2_Tutorial.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OAI 7.2 Fronthaul Interface Tutorial
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI 7.2 Fronthaul Interface 5G SA Tutorial</font></b>
</td>
</tr>
</table>
**Table of Contents** **Table of Contents**
doc/README.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # OpenAirInterface documentation overview
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OpenAirInterface documentation overview</font></b>
</td>
</tr>
</table>
This is the general overview page of the OpenAirInterface documentation. This is the general overview page of the OpenAirInterface documentation.
This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries. This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries.
doc/RUNMODEM.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # Running OAI 5G Softmodems
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">Running OAI 5G Softmodems</font></b>
</td>
</tr>
</table>
This document explains some options for running 5G executables. This document explains some options for running 5G executables.
doc/RUN_NR_PRS.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # Running NR PRS with OAI gNB and nrUE
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "8">Running NR PRS with OAI gNB and nrUE</font></b>
</td>
</tr>
</table>
This page is valid on tags starting from **`2022.w37`**. This page is valid on tags starting from **`2022.w37`**.
doc/analog_beamforming.md
+2
View File
@@ -1,3 +1,5 @@
# Implementation of Analog Beamforming
This document explains the implementation of analog beamforming in OAI codebase. This document explains the implementation of analog beamforming in OAI codebase.
[[_TOC_]] [[_TOC_]]
doc/code-style-contrib.md
+2
View File
@@ -1,3 +1,5 @@
# Contribution Guidelines and Coding Style for Developers
This document lays out the basic contribution policies for developers. It This document lays out the basic contribution policies for developers. It
describes the generel workflow, describes some coding rules, and how code describes the generel workflow, describes some coding rules, and how code
review is performed. review is performed.
doc/cross-compile.md
+3 -1
View File
@@ -1,4 +1,6 @@
OpenAirInterface Cross-Compiler User Guide: explains how to build OAI for ARM64 # OpenAirInterface Cross-Compiler User Guide
This document explains how to build OAI for ARM64
(using the instruction set aarch64). (using the instruction set aarch64).
[[_TOC_]] [[_TOC_]]
doc/dev_tools/sanitizers.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # How to use sanitizers with OAI
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./../images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OAI Build Procedures</font></b>
</td>
</tr>
</table>
[[_TOC_]] [[_TOC_]]
doc/handover-tutorial.md
+2
View File
@@ -1,3 +1,5 @@
# Handover Tutorial for OAI
This tutorial explains how to perform handovers. It covers both F1 handovers This tutorial explains how to perform handovers. It covers both F1 handovers
(intra-gNB, within a single gNB between DUs) and N2 handovers (inter-gNB). (intra-gNB, within a single gNB between DUs) and N2 handovers (inter-gNB).
doc/system_requirements.md
+1 -13
View File
@@ -1,16 +1,4 @@
<table style="border-collapse: collapse; border: none;"> # System Requirements for Using OAI Stack
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">System Requirements for Using OAI Stack</font></b>
</td>
</tr>
</table>
This document describes the minimal and performant system requirements for OpenAirInterface (OAI) 4G/5G software stack (UE and gNB stack). The information provided in this document is based on experimentation, if you have a feedback then open an issue or send an email on the mailing list. This document describes the minimal and performant system requirements for OpenAirInterface (OAI) 4G/5G software stack (UE and gNB stack). The information provided in this document is based on experimentation, if you have a feedback then open an issue or send an email on the mailing list.