Skip to content

Commit 69fa07f

Browse files
feat: add documentation on finch daemon
Signed-off-by: Shubharanshu Mahapatra <[email protected]>
1 parent 7ec7d02 commit 69fa07f

File tree

104 files changed

+8260
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+8260
-1
lines changed

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ test-e2e-opa: linux
123123
DAEMON_ROOT="$(BIN)/finch-daemon" \
124124
$(GINKGO) $(GFLAGS) ./e2e/...
125125

126+
.PHONY: gen-docs
127+
gen-docs:
128+
openapi-generator generate -g markdown -i api/spec/api.yaml -o docs/api
129+
126130
.PHONY: licenses
127131
licenses:
128132
PATH=$(BIN):$(PATH) go-licenses report --template="scripts/third-party-license.tpl" --ignore github.com/runfinch ./... > THIRD_PARTY_LICENSES
@@ -135,4 +139,4 @@ coverage: linux
135139
.PHONY: release
136140
release: linux
137141
@echo "$@"
138-
@$(FINCH_DAEMON_PROJECT_ROOT)/scripts/create-releases.sh $(RELEASE_TAG)
142+
@$(FINCH_DAEMON_PROJECT_ROOT)/scripts/create-releases.sh $(RELEASE_TAG)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[[⬇️ **Download]**](https://github.com/runfinch/finch-daemon/releases)
22
[[🚀 **All Releases]**](https://github.com/runfinch/finch-daemon/releases)
33
[[📚 **Installation]**](#quickstart)
4+
[[📖 **Documentation]**](docs/DOCUMENTATION.md)
45
[[✏️ **Contributing]**](CONTRIBUTING.md)
56

67
# Finch Daemon

0 commit comments

Comments
 (0)