docs: improve readme (#357)

Co-authored-by: Cian Johnston <[email protected]>
Co-authored-by: Muhammad Atif Ali <[email protected]>
(cherry picked from commit 63a383b)

Author: BrunoQuaresma

.github/workflows/ci.yaml

@@ -57,8 +57,8 @@ jobs:
         with:
           go-version: "~1.22"
 
-      - name: Generate docs
-        run: make docs
+      - name: Generate env vars docs
+        run: make docs/env-variables.md
 
       - name: Check for unstaged files
         run: git diff --exit-code

Makefile

@@ -36,7 +36,7 @@ update-golden-files: .gen-golden
 	go test ./options -update
 	@touch "$@"
 
-docs: options/options.go options/options_test.go
+docs/env-variables.md: options/options.go options/options_test.go
 	go run ./scripts/docsgen/main.go
 
 .PHONY: test