Add xapp onboarder guide document

[it/dev.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 0bc154d..127308f 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,14 +7,18 @@
 Welcome to O-RAN SC Integratoin for xApp Development Documentation
 ==================================================================
 
+The it/dev repo is used by the O-RAN SC Integration and Testing project for hosting miscellaneous development codes.
+This repo contains integration artifacts for developing Near Realtime RAN Intelligent Controller applications (xApps).
+
+Because the life cycles of Near Realtime RIC xApps are managed by Near Realtime RIC
+Platform, the xApps are expect to conform with certain behavioral patterns and provide
+well-described interfaces.  The artifacts here help the xApp developers to generate (Near Realtime) RIC Platform deployment ready Helm charts for their xApps.
+
+
+The following is a list of projects hosted by this repo.
+
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
 
-   overview.rst
-   developer-guide.rst
-   release-notes.rst
+   xapp_onboarder/index.rst
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`