Skip to content

docs: improve readme #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 26, 2024
Merged

docs: improve readme #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cb84ac3
docs: improve readme
BrunoQuaresma Sep 25, 2024
7f7a875
Update docs/caching.md
BrunoQuaresma Sep 26, 2024
0ae6327
Update docs/caching.md
BrunoQuaresma Sep 26, 2024
5f60a44
Use SVG
BrunoQuaresma Sep 26, 2024
e14519f
Mention docs on Makefiles
BrunoQuaresma Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading