diff --git a/doc/Aerial_FAPI_Split_Tutorial.md b/doc/Aerial_FAPI_Split_Tutorial.md index 23a510c04d..58380ba611 100644 --- a/doc/Aerial_FAPI_Split_Tutorial.md +++ b/doc/Aerial_FAPI_Split_Tutorial.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI 7.2 Fronthaul Interface 5G SA Tutorial -
+# OAI 7.2 Fronthaul Interface 5G SA Tutorial **Table of Contents** diff --git a/doc/BUILD.md b/doc/BUILD.md index 4a8bcaa712..40394214d4 100644 --- a/doc/BUILD.md +++ b/doc/BUILD.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI Build Procedures -
+# OAI Build Procedures [[_TOC_]] diff --git a/doc/E1AP/e1ap_procedures.md b/doc/E1AP/e1ap_procedures.md index 671f77bd45..d860ffbe47 100644 --- a/doc/E1AP/e1ap_procedures.md +++ b/doc/E1AP/e1ap_procedures.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - E1AP Procedures -
+# E1AP Procedures [[_TOC_]] diff --git a/doc/F1AP/F1-design.md b/doc/F1AP/F1-design.md index 04605561e0..888a68c33f 100644 --- a/doc/F1AP/F1-design.md +++ b/doc/F1AP/F1-design.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - F1 split design -
+# F1 split design [[_TOC_]] diff --git a/doc/F1AP/F1AP-lib.md b/doc/F1AP/F1AP-lib.md index 443ee1415b..3221596187 100644 --- a/doc/F1AP/F1AP-lib.md +++ b/doc/F1AP/F1AP-lib.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - F1AP Messages Encoding & Decoding Library -
+# F1AP Messages Encoding & Decoding Library [[_TOC_]] diff --git a/doc/FEATURE_SET.md b/doc/FEATURE_SET.md index 117ef79c20..9ef67c5c2d 100644 --- a/doc/FEATURE_SET.md +++ b/doc/FEATURE_SET.md @@ -1,3 +1,5 @@ +# Feature Set + **Table of Contents** [[_TOC_]] diff --git a/doc/L1SIM.md b/doc/L1SIM.md index 401f30e470..eef27540fa 100644 --- a/doc/L1SIM.md +++ b/doc/L1SIM.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - Open Air LTE Emulation -
+# Open Air LTE Emulation > **Note: Unless you know what you are doing, you likely do not need this!** Rather, you are probably looking for the diff --git a/doc/L2NFAPI.md b/doc/L2NFAPI.md index 5577e4821f..41400ed3a1 100644 --- a/doc/L2NFAPI.md +++ b/doc/L2NFAPI.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - L2 nFAPI Simulator Usage -
+# L2 nFAPI Simulator Usage ## 4G L2 nFAPI simulator diff --git a/doc/L2NFAPI_NOS1.md b/doc/L2NFAPI_NOS1.md index a492852496..4e54b34f64 100644 --- a/doc/L2NFAPI_NOS1.md +++ b/doc/L2NFAPI_NOS1.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - L2 nFAPI Simulator (no S1 Mode / 2-host deployment) -
+# L2 nFAPI Simulator (no S1 Mode / 2-host deployment) > **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.** diff --git a/doc/L2NFAPI_S1.md b/doc/L2NFAPI_S1.md index 8db2423cc2..c22e78c165 100644 --- a/doc/L2NFAPI_S1.md +++ b/doc/L2NFAPI_S1.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - L2 nFAPI Simulator (with S1 / 2-host deployment) -
+# L2 nFAPI Simulator (with S1 / 2-host deployment) > **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.** diff --git a/doc/LDPC_OFFLOAD_SETUP.md b/doc/LDPC_OFFLOAD_SETUP.md index e23936ae6d..36f635a231 100644 --- a/doc/LDPC_OFFLOAD_SETUP.md +++ b/doc/LDPC_OFFLOAD_SETUP.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI LDPC offload (O-RAN AAL/DPDK BBDEV) -
+# OAI LDPC offload (O-RAN AAL/DPDK BBDEV) **Table of Contents** diff --git a/doc/NR_NFAPI_archi.md b/doc/NR_NFAPI_archi.md index 12b0e144cc..5f7eb3147b 100644 --- a/doc/NR_NFAPI_archi.md +++ b/doc/NR_NFAPI_archi.md @@ -1,3 +1,5 @@ +# SmallCellForum 5G (n)FAPI split + This document describes the broad way in which the VNF and PNF work internally, from configuration, to P5 and P7 message exchange and processing. Their internal processing is broadly independent on which transport mechanism diff --git a/doc/NR_SA_Tutorial_COTS_UE.md b/doc/NR_SA_Tutorial_COTS_UE.md index 75e8d49272..2e99f04e1e 100644 --- a/doc/NR_SA_Tutorial_COTS_UE.md +++ b/doc/NR_SA_Tutorial_COTS_UE.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI 5G NR SA tutorial with COTS UE -
+# OAI 5G NR SA tutorial with COTS UE **Table of Contents** diff --git a/doc/NR_SA_Tutorial_OAI_CN5G.md b/doc/NR_SA_Tutorial_OAI_CN5G.md index d16a0914fd..6a4983a85f 100644 --- a/doc/NR_SA_Tutorial_OAI_CN5G.md +++ b/doc/NR_SA_Tutorial_OAI_CN5G.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI 5G NR SA tutorial: setting up OAI CN5G -
+# OAI 5G NR SA tutorial: setting up OAI CN5G **Table of Contents** diff --git a/doc/NR_SA_Tutorial_OAI_multi_UE.md b/doc/NR_SA_Tutorial_OAI_multi_UE.md index 24a2e7b8c1..b8dd003e98 100644 --- a/doc/NR_SA_Tutorial_OAI_multi_UE.md +++ b/doc/NR_SA_Tutorial_OAI_multi_UE.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI 5G NR SA tutorial to deploy multiple OAI nrUE -
+# OAI 5G NR SA tutorial to deploy multiple OAI nrUE **Table of Contents** diff --git a/doc/NR_SA_Tutorial_OAI_nrUE.md b/doc/NR_SA_Tutorial_OAI_nrUE.md index 5492b59f6b..3a6a949505 100644 --- a/doc/NR_SA_Tutorial_OAI_nrUE.md +++ b/doc/NR_SA_Tutorial_OAI_nrUE.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI 5G NR SA tutorial with OAI nrUE -
+# OAI 5G NR SA tutorial with OAI nrUE **Table of Contents** diff --git a/doc/ORAN_FHI7.2_Tutorial.md b/doc/ORAN_FHI7.2_Tutorial.md index 7d3e748e99..0443089e47 100644 --- a/doc/ORAN_FHI7.2_Tutorial.md +++ b/doc/ORAN_FHI7.2_Tutorial.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI 7.2 Fronthaul Interface 5G SA Tutorial -
+# OAI 7.2 Fronthaul Interface Tutorial **Table of Contents** diff --git a/doc/README.md b/doc/README.md index efc5cf4487..b728768e6f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OpenAirInterface documentation overview -
+# OpenAirInterface documentation overview 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. diff --git a/doc/RUNMODEM.md b/doc/RUNMODEM.md index 46f325292d..d52f51d381 100644 --- a/doc/RUNMODEM.md +++ b/doc/RUNMODEM.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - Running OAI 5G Softmodems -
+# Running OAI 5G Softmodems This document explains some options for running 5G executables. diff --git a/doc/RUN_NR_PRS.md b/doc/RUN_NR_PRS.md index 270967ee7a..1b5759ccf8 100644 --- a/doc/RUN_NR_PRS.md +++ b/doc/RUN_NR_PRS.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - Running NR PRS with OAI gNB and nrUE -
+# Running NR PRS with OAI gNB and nrUE This page is valid on tags starting from **`2022.w37`**. diff --git a/doc/analog_beamforming.md b/doc/analog_beamforming.md index 41b7ad8441..ef2833e983 100644 --- a/doc/analog_beamforming.md +++ b/doc/analog_beamforming.md @@ -1,3 +1,5 @@ +# Implementation of Analog Beamforming + This document explains the implementation of analog beamforming in OAI codebase. [[_TOC_]] diff --git a/doc/code-style-contrib.md b/doc/code-style-contrib.md index 82fe9c8baa..fd11d4e287 100644 --- a/doc/code-style-contrib.md +++ b/doc/code-style-contrib.md @@ -1,3 +1,5 @@ +# Contribution Guidelines and Coding Style for Developers + This document lays out the basic contribution policies for developers. It describes the generel workflow, describes some coding rules, and how code review is performed. diff --git a/doc/cross-compile.md b/doc/cross-compile.md index c4c1be98ef..69e59cb832 100644 --- a/doc/cross-compile.md +++ b/doc/cross-compile.md @@ -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). [[_TOC_]] diff --git a/doc/dev_tools/sanitizers.md b/doc/dev_tools/sanitizers.md index 920a2f05a7..11c2759121 100644 --- a/doc/dev_tools/sanitizers.md +++ b/doc/dev_tools/sanitizers.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - OAI Build Procedures -
+# How to use sanitizers with OAI [[_TOC_]] diff --git a/doc/handover-tutorial.md b/doc/handover-tutorial.md index c669d87768..a4edecd193 100644 --- a/doc/handover-tutorial.md +++ b/doc/handover-tutorial.md @@ -1,3 +1,5 @@ +# Handover Tutorial for OAI + 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). diff --git a/doc/system_requirements.md b/doc/system_requirements.md index 41c368f942..82ae0d4563 100644 --- a/doc/system_requirements.md +++ b/doc/system_requirements.md @@ -1,16 +1,4 @@ - - - - - -
- - - - - - System Requirements for Using OAI Stack -
+# System Requirements for Using OAI Stack 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.