Improve documentation

Issue-ID: NONRTRIC-819
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Change-Id: If9d42dd78d0e13bddcd4bc2d2e34fc0cf8eaf495

diff --git a/README.md b/README.md
index bd56ce4..b190bd9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 # O-RAN-SC Non-RT RIC Control Panel Web Application
 
 The O-RAN Non-RT RIC Control Panel provides administrative and operator functions for a Near-RT RIC through the A1 API.
-This web app consists of an Angular (version 9) front end
-and a Java (version 11) Spring Cloud Gateway (version 2020.0.0).
+This web app consists of an Angular (version 9) front end, see [frontend](webapp-frontend/README.md),
+and a Java (version 11) Spring Cloud Gateway (version 2020.0.0), see [gateway](nonrtric-gateway/README.md).
 
 Please see the documentation in the docs/ folder.
 

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 2c62f33..bd350c5 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -5,7 +5,7 @@
 Developer Guide
 ===============
 
-This document provides a quickstart for developers of the Non-RT RIC Control Panel.
+This document provides a quick start for developers of the Non-RT RIC Control Panel.
 
 The Non-RT RIC Control Panel is an interface that allows human users to create, edit and delete policy instances, for
 each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC. It is also

diff --git a/nonrtric-gateway/README.md b/nonrtric-gateway/README.md
index 23eec31..0b3535c 100644 (file)
--- a/nonrtric-gateway/README.md
+++ b/nonrtric-gateway/README.md
@@ -4,7 +4,6 @@ The O-RAN Non-RT RIC ControlPanel Gateway provides an API Gateway for all the No
 
 The application is a spring cloud gateway and all the route configurations are provided in application.yaml.
 
-
 ## License
 
 Copyright (C) 2021 Nordix Foundation. All rights reserved.

diff --git a/webapp-frontend/README.md b/webapp-frontend/README.md
index 09a1641..04e40fe 100644 (file)
--- a/webapp-frontend/README.md
+++ b/webapp-frontend/README.md
@@ -7,6 +7,7 @@ Run `./ng serve --proxy-config proxy.conf.json` or `npm start` for a dev server.
 You may also need to Start the Control Panel Gateway, Policy Management Service & EI Coordinator if you want to view the data in UI.
 
 ## Development server with Mock Data
+
 Run `npm run start:mock` for a dev server with mock data. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. This enables the developer to test the UI without the need of backend.
 
 ## Build