fix: Small readme

Author: ilyakuz-db

Makefile

@@ -35,8 +35,9 @@ schema:
 	@go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema.json
 
 docs:
-	@echo "✓ Generating docs ..."
+	@echo "✓ Generating docs using ./bundle/internal/schema/annotations.yml file..."
 	@go run ./bundle/internal/docs ./bundle/internal/schema ./bundle/internal/docs/docs.md
+	@echo "✓ Writing docs to ./bundle/internal/docs/docs.md"
 
 INTEGRATION = gotestsum --format github-actions --rerun-fails --jsonfile output.json --packages "./integration/..." -- -parallel 4 -timeout=2h
 

bundle/internal/docs/README.md

@@ -0,0 +1,7 @@
+## docs-autogen
+
+1. Install [Golang](https://go.dev/doc/install)
+2. Run `go mod download` from the repo root
+3. Run `make docs` from the repo
+4. See generated document in `./bundle/internal/docs/docs.md`
+5. To change descriptions update content in `./bundle/internal/schema/annotations.yml` and re-run `make docs`

go.mod

@@ -33,6 +33,8 @@ require (
 	gopkg.in/yaml.v3 v3.0.1
 )
 
+require github.com/nao1215/markdown v0.6.0
+
 require (
 	cloud.google.com/go/auth v0.4.2 // indirect
 	cloud.google.com/go/auth/oauth2adapt v0.2.2 // indirect
@@ -56,10 +58,8 @@ require (
 	github.com/karrick/godirwalk v1.17.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-runewidth v0.0.9 // indirect
-	github.com/nao1215/markdown v0.6.0 // indirect
 	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/radovskyb/watcher v1.0.7 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
 	github.com/zclconf/go-cty v1.15.0 // indirect
 	go.opencensus.io v0.24.0 // indirect