From 7a04cc384a6293ed918f7e3b42e2bba86dff82d7 Mon Sep 17 00:00:00 2001 From: dylanhitt Date: Sun, 7 Jul 2024 17:50:56 -0400 Subject: [PATCH] chore: fix ci markdwon ci check, align make target with ci, and fix md issues --- .github/ISSUE_TEMPLATE/bug_report.md | 3 ++- .github/ISSUE_TEMPLATE/feature_request.md | 3 ++- .github/workflows/lint.yaml | 2 ++ Makefile | 2 +- README.md | 17 ++++++++++------- documentation/README.md | 2 +- 6 files changed, 18 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fe857f80..1ee4957f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -20,7 +20,8 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Framework version (please check if it happens with the last Fuego version before posting):** +**Framework version (please check if it happens with the last +Fuego version before posting):** **Go version (please check if it happens with the last Go version before posting):** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 11fc491e..e4ffaa70 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,7 +8,8 @@ assignees: '' --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. +Ex. I'm always frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 181f3f5d..d6c343bf 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -9,6 +9,8 @@ jobs: markdownlint: runs-on: ubuntu-latest steps: + - uses: actions/checkout@v4 + - name: markdownlint-cli uses: nosborn/github-action-markdown-cli@v3.3.0 with: diff --git a/Makefile b/Makefile index 2b3d0e75..b506048a 100644 --- a/Makefile +++ b/Makefile @@ -30,7 +30,7 @@ lint: go run github.com/golangci/golangci-lint/cmd/golangci-lint@latest run lint-markdown: - markdownlint --fix . + markdownlint --dot . example: ( cd examples/full-app-gourmet && go run . -debug ) diff --git a/README.md b/README.md index 5da6c055..19746498 100644 --- a/README.md +++ b/README.md @@ -22,22 +22,25 @@ see [the example](./examples/full-app-gourmet) - actually running [in prod](http ## Sponsors -Fuego is proudly sponsored by [Zuplo](https://zuplo.link/fuego-gh), that provides [a Fuego integration](https://zuplo.link/fuego-gh)! +Fuego is proudly sponsored by [Zuplo](https://zuplo.link/fuego-gh), +that provides [a Fuego integration](https://zuplo.link/fuego-gh)!
-Fuego Logo + Fuego Logo
-> Zuplo allows you to secure your Fuego API, scale it globally, generate documentation from your OpenAPI, and monetize your users. +> Zuplo allows you to secure your Fuego API, scale it globally, +generate documentation from your OpenAPI, and monetize your users. ## Why Fuego? Chi, Gin, Fiber and Echo are great frameworks. But since they were designed a long time ago, -[their current API does not allow them][gin-gonic-issue] -to deduce OpenAPI types from signatures, things that are -now possible with generics. Fuego offers a lot of "modern Go based" -features that make it easy to develop APIs and web applications. +[their current API does not allow them][gin-gonic-issue] to deduce +OpenAPI types from signatures, things that are now possible with generics. +Fuego offers a lot of "modern Go based" features that make it easy +to develop APIs and web applications. ## Features diff --git a/documentation/README.md b/documentation/README.md index a82d3186..33562d26 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -3,7 +3,7 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. -### Installation +## Installation ```sh yarn