From 8f75336cb802b770d1ac53efb155632dd2dd94d2 Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Thu, 8 Apr 2021 20:59:35 +0200 Subject: docs: Revamp project documentation This change updates the project documentation by moving most of the documentation to the docs directory. --- opendc-web/opendc-web-api/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'opendc-web/opendc-web-api/README.md') diff --git a/opendc-web/opendc-web-api/README.md b/opendc-web/opendc-web-api/README.md index 182cd803..4932f823 100644 --- a/opendc-web/opendc-web-api/README.md +++ b/opendc-web/opendc-web-api/README.md @@ -1,5 +1,5 @@

- OpenDC + OpenDC
OpenDC Web Server

@@ -9,7 +9,7 @@
-The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](../opendc-api-spec.yml). +The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](../../opendc-api-spec.yml). This document explains a high-level view of the web server architecture ([jump](#architecture)), and describes how to set up the web server for local development ([jump](#setup-for-local-development)). -- cgit v1.2.3