Updated README and docs

Author: loleg

README.md

@@ -2,11 +2,17 @@
 
 A web application for publishing and collaborating around urban planning projects. This project is part of the  [Cividi](https://cividi.ch) solution for holistic urban assessments, used as a tool for setting planning priorities.
 
-For more information, please visit https://gemeindescan.ch or read our [whitepaper](https://bitbucket.org/cividi/whitepaper).
+For more information, please visit [Gemeindescan.ch](https://gemeindescan.ch) and read our [Whitepaper](https://bitbucket.org/cividi/whitepaper).
 
-# Releases
+# Additional documentation
 
-*See [RELEASE.md](/RELEASE.md)*
+- [Release notes](./RELEASE.md)
+- [Architecture](./docs/architecture.md)
+- [Troubleshooting](./docs/troubleshooting.md)
+- [Test guide](./docs/testing.md)
+- [Django](./docs/django.md)
+- [GraphQL](./docs/graphql.md)
+- [Further links](./docs/links.md)
 
 # Developer guide
 
@@ -20,7 +26,7 @@ For more information, please visit https://gemeindescan.ch or read our [whitepap
 - Wagtail
 - Docker
 
-For a tour of the app and a testing protocol see [`docs/testing.md`](/docs/testing.md).
+For a tour of the app and a testing protocol see [`docs/testing.md`](./docs/testing.md).
 
 ## setup project
 
@@ -140,11 +146,3 @@ Type `make` in the vscode terminal, that creates the django dev server on your m
 ## deploy
 
 Type `make deploy_prod` in the project root. The file `env.hosts.prod` needs to have the right settings.
-
-## additional docs
-
-- [architecture](/docs/architecture.md)
-- [django](/docs/django.md)
-- [links](/docs/links.md)
-- [grahpql](/docs/graphql.md)
-- [troubleshooting](/docs/troubleshooting.md)

RELEASE.md

@@ -2,6 +2,16 @@
 
 ## Releases
 
+### 0.6.1
+
+### 0.6.0
+
+### 0.5.1
+
+### 0.5.0
+
+### 0.4.0
+
 ### 0.3.1
 [Released: *2020-04-09*](https://bitbucket.org/cividi/gemeindescan-webui/commits/tag/0.3.1)
 [Sprint: 4 "Out of the Box"](https://bitbucket.org/cividi/gemeindescan-webui/issues?milestone=SP+4%3A+Out+of+the+box)

docs/architecture.md

@@ -1,6 +1,6 @@
-# architecture
+# Architecture
 
-## django
+_Notes on the architecture of the project._
 
 We switch to graphne + django. Our main goal is to have a backend service that speaks graphql. FastAPI doesn’t brings much to the table in this regard.
 The focus of FastAPI Is OpenAPI which is REST based. Also Swagger UI is build for REST. The graphql part is just reused from Starlette which itself uses graphene.

docs/django.md

@@ -1,4 +1,6 @@
-# django
+# Django
+
+_Notes on our usage of the Django Framework._
 
 ## init project
 

docs/graphql.md

@@ -1,9 +1,11 @@
-# graphql
+# GraphQL
 
-go to '/graphql/' which opens the GraphiQL browser
+_Notes on our usage of the GraphQL-based query API._
 
 ## sample queries
 
+go to '/graphql/' which opens the GraphiQL browser
+
 ### gemeinden
 
 ```graphql
@@ -45,5 +47,3 @@ The `MunicipalityNode` has the fields
   }
 }
 ```
-
-

docs/links.md

@@ -1,4 +1,4 @@
-# links
+# Further References
 
 ## django
 

docs/troubleshooting.md

@@ -1,15 +1,15 @@
-# troubleshooting
+# Troubleshooting
 
 ## init
 
 If you want/need a clean state you can delete the var docker volume.
 `docker volume rm var-gemeindescan-webui`
 
-## vscode 
+## vscode
 
 If you have a vscode related problem it could help to delete the vscode docker volume.
-- django: `docker volume rm gemeindescan-webui_vscode-remote-django` 
-- vue: `docker volume rm gemeindescan-webui_vscode-remote-vue` 
+- django: `docker volume rm gemeindescan-webui_vscode-remote-django`
+- vue: `docker volume rm gemeindescan-webui_vscode-remote-vue`
 
 ## windows