Skip to content

Commit

Permalink
chore: fix ci markdwon ci check, align make target with ci, and fix m…
Browse files Browse the repository at this point in the history
…d issues
  • Loading branch information
dylanhitt committed Jul 8, 2024
1 parent 95b262e commit cf7d254
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 11 deletions.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):**

Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ jobs:
markdownlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: markdownlint-cli
uses: nosborn/[email protected]
with:
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 )
Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)!

<div align="center">
<img src="./assets/Zuplo.png" style="border-radius:10px" height="100" alt="Fuego Logo" />
<img src="./assets/Zuplo.png" style="border-radius:10px" height="100"
alt="Fuego Logo" />
</div>

> 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

Expand Down
2 changes: 1 addition & 1 deletion documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This website is built using [Docusaurus](https://docusaurus.io/),
a modern static website generator.

### Installation
## Installation

```sh
yarn
Expand Down

0 comments on commit cf7d254

Please sign in to comment.