chore: improve Make help command (#3640)

Author: rootulp

Makefile

@@ -39,7 +39,7 @@ build:
 	@go build -o build/ ${LDFLAGS} ./cmd/celestia
 .PHONY: build
 
-## build-jemalloc: Build celestia-node binary with jemalloc allocator for BadgerDB instead of Go's native one
+## build-jemalloc: Build celestia-node binary with jemalloc allocator for BadgerDB.
 build-jemalloc: jemalloc
 	@echo "--> Building Celestia with jemalloc"
 	@go build -o build/ ${LDFLAGS} -tags jemalloc ./cmd/celestia
@@ -51,14 +51,14 @@ clean:
 	@rm -rf build/*
 .PHONY: clean
 
-## cover: generate to code coverage report.
+## cover: Generate code coverage report.
 cover:
 	@echo "--> Generating Code Coverage"
 	@go install github.com/ory/go-acc@latest
 	@go-acc -o coverage.txt `go list ./... | grep -v nodebuilder/tests` -- -v
 .PHONY: cover
 
-## deps: install dependencies.
+## deps: Install dependencies.
 deps:
 	@echo "--> Installing Dependencies"
 	@go mod download
@@ -73,7 +73,7 @@ else
 endif
 .PHONY: install
 
-## install-global: Install the celestia-node binary (only for systems that support GNU coreutils, i.e. Linux).
+## install-global: Install the celestia-node binary (only for systems that support GNU coreutils like Linux).
 install-global:
 	@echo "--> Installing Celestia"
 	@install -v ./build/* -t ${PREFIX}/bin
@@ -109,7 +109,8 @@ install-key:
 	@go install ./cmd/cel-key
 .PHONY: install-key
 
-## fmt: Formats only *.go (excluding *.pb.go *pb_test.go). Runs `gofmt & goimports` internally.
+## fmt: Formats only *.go (excluding *.pb.go *pb_test.go).
+# Runs `gofmt & goimports` internally.
 fmt: sort-imports
 	@find . -name '*.go' -type f -not -path "*.git*" -not -name '*.pb.go' -not -name '*pb_test.go' | xargs gofmt -w -s
 	@go mod tidy -compat=1.20
@@ -118,39 +119,40 @@ fmt: sort-imports
 	@markdownlint --fix --quiet --config .markdownlint.yaml .
 .PHONY: fmt
 
-## lint: Linting *.go files using golangci-lint. Look for .golangci.yml for the list of linters. Also lint *.md files using markdownlint.
+## lint: Lint *.go files with golangci-lint and *.md files with markdownlint.
+# Look at .golangci.yml for the list of linters.
 lint: lint-imports
 	@echo "--> Running linter"
 	@golangci-lint run
 	@markdownlint --config .markdownlint.yaml '**/*.md'
 	@cfmt --m=120 ./...
 .PHONY: lint
 
-## test-unit: Running unit tests
+## test-unit: Run unit tests.
 test-unit:
 	@echo "--> Running unit tests"
 	@go test $(VERBOSE) -covermode=atomic -coverprofile=coverage.txt `go list ./... | grep -v nodebuilder/tests` $(LOG_AND_FILTER)
 .PHONY: test-unit
 
-## test-unit-race: Running unit tests with data race detector
+## test-unit-race: Run unit tests with data race detector.
 test-unit-race:
 	@echo "--> Running unit tests with data race detector"
 	@go test $(VERBOSE) -race -covermode=atomic -coverprofile=coverage.txt `go list ./... | grep -v nodebuilder/tests` $(LOG_AND_FILTER)
 .PHONY: test-unit-race
 
-## test-integration: Running /integration tests located in nodebuilder/tests
+## test-integration: Run integration tests located in nodebuilder/tests.
 test-integration:
 	@echo "--> Running integrations tests $(VERBOSE) -tags=$(TAGS) $(INTEGRATION_RUN_LENGTH)"
 	@go test $(VERBOSE) -tags=$(TAGS) $(INTEGRATION_RUN_LENGTH) ./nodebuilder/tests
 .PHONY: test-integration
 
-## test-integration-race: Running integration tests with data race detector located in node/tests
+## test-integration-race: Run integration tests with data race detector located in nodebuilder/tests.
 test-integration-race:
 	@echo "--> Running integration tests with data race detector -tags=$(TAGS)"
 	@go test -race -tags=$(TAGS) ./nodebuilder/tests
 .PHONY: test-integration-race
 
-## benchmark: Running all benchmarks
+## benchmark: Run all benchmarks.
 benchmark:
 	@echo "--> Running benchmarks"
 	@go test -run="none" -bench=. -benchtime=100x -benchmem ./...
@@ -173,14 +175,14 @@ pb-gen:
 	done;
 .PHONY: pb-gen
 
-## openrpc-gen: Generate OpenRPC spec for Celestia-Node's RPC api
+## openrpc-gen: Generate OpenRPC spec for celestia-node's RPC API.
 openrpc-gen:
 	@go run ${LDFLAGS} ./cmd/celestia docgen
 .PHONY: openrpc-gen
 
 ## lint-imports: Lint only Go imports.
-## flag -set-exit-status doesn't exit with code 1 as it should, so we use find until it is fixed by goimports-reviser
 lint-imports:
+# flag -set-exit-status doesn't exit with code 1 as it should, so we use find until it is fixed by goimports-reviser
 	@echo "--> Running imports linter"
 	@for file in `find . -type f -name '*.go'`; \
 		do goimports-reviser -list-diff -set-exit-status -company-prefixes "github.com/celestiaorg" -project-name "github.com/celestiaorg/celestia-node" -output stdout $$file \
@@ -199,13 +201,13 @@ adr-gen:
 	@curl -sSL https://raw.githubusercontent.com/celestiaorg/.github/main/adr-template.md > docs/architecture/adr-$(NUM)-$(TITLE).md
 .PHONY: adr-gen
 
-## telemetry-infra-up: launches local telemetry infrastructure. This includes grafana, jaeger, loki, pyroscope, and an otel-collector.
-## you can access the grafana instance at localhost:3000 and login with admin:admin.
+## telemetry-infra-up: Launch local telemetry infra (grafana, jaeger, loki, pyroscope, and otel-collector).
+# You can access the grafana instance at localhost:3000 and login with admin:admin.
 telemetry-infra-up:
 	PWD="${DIR_FULLPATH}/docker/telemetry" docker-compose -f ./docker/telemetry/docker-compose.yml up
 .PHONY: telemetry-infra-up
 
-## telemetry-infra-down: tears the telemetry infrastructure down. The stores for grafana, prometheus, and loki will persist.
+## telemetry-infra-down: Tears the telemetry infra down. Persists the stores for grafana, prometheus, and loki.
 telemetry-infra-down:
 	PWD="${DIR_FULLPATH}/docker/telemetry" docker-compose -f ./docker/telemetry/docker-compose.yml down
 .PHONY: telemetry-infra-down
@@ -222,7 +224,8 @@ goreleaser-build:
 	goreleaser build --snapshot --clean --single-target
 .PHONY: goreleaser-build
 
-## goreleaser-release: Builds the release celestia binaries as defined in .goreleaser.yaml. This requires there be a git tag for the release in the local git history.
+## goreleaser-release: Builds the release celestia binaries as defined in .goreleaser.yaml.
+# This requires there be a git tag for the release in the local git history.
 goreleaser-release:
 	goreleaser release --clean --fail-fast --skip-publish
 .PHONY: goreleaser-release
@@ -232,7 +235,7 @@ USER_ID      = $(shell id -u)
 HAS_JEMALLOC = $(shell test -f /usr/local/lib/libjemalloc.a && echo "jemalloc")
 JEMALLOC_URL = "https://github.com/jemalloc/jemalloc/releases/download/5.2.1/jemalloc-5.2.1.tar.bz2"
 
-## jemalloc installs jemalloc allocator
+## jemalloc: Install jemalloc allocator.
 jemalloc:
 	@if [ -z "$(HAS_JEMALLOC)" ] ; then \
 		mkdir -p /tmp/jemalloc-temp && cd /tmp/jemalloc-temp ; \