add doc

Makefile

@@ -25,6 +25,7 @@ lint:
 check: version/commit.txt version/version.txt lint
 	go test -timeout 30m $(PROJECT)/... -cover
 
+# generates database schemas locally to inspect them.
 generate-schemas:
 	@./local/jimm/generate_db_schemas.sh
 

local/README.md

@@ -74,4 +74,4 @@ controllers that will be controlled by JIMM.
 - The WS API for JIMM Controller is under: `ws://localhost:17070` (http direct) and `wss://jimm.localhost` for secure.
 - You can verify local deployment with: `curl http://localhost:17070/debug/status` and `curl https://jimm.localhost/debug/status`
 - Traefik is available on `http://localhost:8089`.
-- You can generate db schemas from your running postgres by using `make generate-schemas`
+- You can generate db schemas from the running deployment postgres to inspect the raw sql by using `make generate-schemas`.

local/jimm/generate_db_schemas.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# This script generates database schema from our running postgres deployment docker compose.
+# Its purpose is to better inspect raw SQL generating our db models.
+
 # Configuration
 DB_CONTAINER="postgres"   
 SCHEMA="public"