X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=d7e3537b40211dc41169093d48c9da0558b564d9;hb=081194086380b739d5158874b87b4f86de2976c6;hp=57a9d347642955af9d4bdf523541487fcbbce746;hpb=ad3e8f6d45b1b1e14302d5adfc6c656fe115f547;p=it%2Fdev.git diff --git a/docs/index.rst b/docs/index.rst index 57a9d34..d7e3537 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,18 +4,22 @@ .. Copyright (C) 2019 AT&T Intellectual Property -Welcome to O-RAN SC it/dev Documentation -=========================================== +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 + xapp_onboarder/index.rst release-notes.rst - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search`