From f1d9638e37eb883fe23b293ad2480547d72afd3c Mon Sep 17 00:00:00 2001 From: Romain Beurdouche Date: Tue, 19 Nov 2024 09:33:20 +0100 Subject: [PATCH] Add note to 'doc/README.md' to insight readers to checkout the documentation at their version of the repository. --- doc/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/README.md b/doc/README.md index 3219c849cb..1c9e1dc784 100644 --- a/doc/README.md +++ b/doc/README.md @@ -12,6 +12,15 @@ +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. + +**IMPORTANT NOTE:** +Before reading this documentation, we strongly advise you to keep your own repository rebased on `develop` +or at least to checkout the documentation on the version of the repository you are using. +Then the documentation will better reflect the features available in your repository so that you may avoid some errors. +Beware if you previously pulled the `develop` branch that your repository may be now behind `develop`. + [[_TOC_]] # General