From fbb982444275da8aadaf8b111f6975b865c3c2e5 Mon Sep 17 00:00:00 2001
From: Julian Lobbes <julian.lobbes@protonmail.com>
Date: Wed, 2 Aug 2023 15:17:46 +0200
Subject: [PATCH] docs: fix typos and broken links

---
 README.md          | 32 +++++++++++++++-----------------
 app/core/README.md | 12 ++++++------
 2 files changed, 21 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index cc9f15b..ff3ba5b 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,21 @@
 # MEDWings
 
 Medwings is the *Mobile Early Deterioration Warning System*.
-It is a prrof of concept for a remote patient monitoring system, designed for use by elevated-risk patients
+It is a proof of concept for a remote patient monitoring system, designed for use by elevated-risk patients
 outside of direct medical supervision, such as at home or on the go.
 
 The application utilizes smart medical devices to access vitals data gathered by users remotely.
 Data is aggregated, and a clinical early warning score is calculated based on the readings.
 
-A detailed explanation and formula [can be found here](https://www.mdcalc.com/calc/1875/modified-early-warning-score-mews-clinical-deterioration#evidence).
+The Medwings application is split into different modules, each handling a specific responsibility:
+
+- [core](./app/core/README.md): global files and configuration
+- [authentication](./app/authentication/README.md): user creation and login/logout management
+- [medwings](./app/medwings/README.md): everything related to vitals data and MEWS calculation
+- [gotify](./app/gotify/README.md): interfaces to the notification server
+- [withings](./app/withings/README.md): interfaces to the Withings API
+
+You can read more about each module and its functionality in each section mentioned above.
 
 ## Development
 
@@ -30,8 +38,8 @@ GOTIFY_USER=gotify
 GOTIFY_PASSWORD=secret
 GOTIFY_HOST=medwings-gotify
 GOTIFY_PUBLIC_URL=https://notifications.medwings.example.com/
-WITHINGS_CLIENT_ID=<client_id>
-WITHINGS_CLIENT_SECRET=<client_secret>
+WITHINGS_CLIENT_ID=abc123myClientId
+WITHINGS_CLIENT_SECRET=abc123myClientSecret
 ```
 
 You should set the values of the following variables:
@@ -41,9 +49,9 @@ You should set the values of the following variables:
 | PG_PASSWORD | password for the PostgreSQL admin user | a random string of 32 characters |
 | GOTIFY_USER | name of the Gotify admin user | a random string of 32 characters |
 | GOTIFY_PASSWORD | password for the Gotify admin user | a random string of 32 characters |
-| GOTIFY_PUBLIC_URL | URL where your public Gotify server can be reached | a random string of 32 characters |
-| WITHINGS_CLIENT_ID | Your Withings API client id | see (Withings API)[/app/withings/README.md#api-access] |
-| WITHINGS_CLIENT_SECRET | Your Withings API client secret | see (Withings API)[/app/withings/README.md#api-access] |
+| GOTIFY_PUBLIC_URL | URL where your public Gotify server can be reached | this depends on your deployment environment |
+| WITHINGS_CLIENT_ID | Your Withings API client id | see [Withings API](./app/withings/README.md#api-access) |
+| WITHINGS_CLIENT_SECRET | Your Withings API client secret | see [Withings API](./app/withings/README.md#api-access) |
 
 
 ### Starting the dev environment
@@ -79,13 +87,3 @@ To enter django's interactive shell, run:
 ```bash
 sudo docker exec -itu medwings-django python manage.py shell
 ```
-
-### Application design
-
-The application is split into different modules, each handling a specific responsibility:
-
-- [core](/app/core/README.md): global files and configuration
-- [authentication](/app/authentication/README.md): user creation and login/logout management
-- [medwings](/app/medwings/README.md): everything related to vitals data and MEWS calculation
-- [gotify](/app/gotify/README.md): interfaces to the notification server
-- [withings](/app/withings/README.md): interfaces to the Withings API
diff --git a/app/core/README.md b/app/core/README.md
index c584a0c..3e89fba 100644
--- a/app/core/README.md
+++ b/app/core/README.md
@@ -1,24 +1,24 @@
 # Core
 
-This module is the main entrypoint for the application
+This module is the main entrypoint for the application.
 It provides global configuration variables and shared files.
 
 ## Templates
 
-Shared template files are defined in (./templates/core/)[/app/core/templates/core/].
+Shared template files are defined in [./templates/core/](./templates/core/).
 
 These include the base template, which all others inherit from, as well as the navigation bar and footer of the site.
 
 ## Static files
 
-Static files are stored in (/app/static/)[/app/static/] and served here by the webserver.
+Static files are stored in [/app/static/](../app/static/) and served here by the webserver.
 
-**Warning:** files stored in this directory are publically available.
+**Warning:** files stored in this directory are publicly available.
 
-You can access static files in your template as follows:
+You can access static files in your Django template as follows:
 
 ```html
-`{% load static %}`
+{% load static %}
 
 ...