Skip to content

Commit

Permalink
doc(main): Updated documentation (#278)
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkinox authored Aug 8, 2024
1 parent 39f01ea commit f42bf67
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/tutorials/http-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To create your `github.com/foo/bar` repository, you can use the [HTTP applicatio
It provides:

- a ready to extend [Yokai](https://github.com/ankorstore/yokai) application, with the [HTTP server](../modules/fxhttpserver.md) module installed
- a ready to use [dev environment](https://github.com/ankorstore/yokai-http-template/blob/main/docker-compose.yaml), based on [Air](https://github.com/cosmtrek/air) (for live reloading)
- a ready to use [dev environment](https://github.com/ankorstore/yokai-http-template/blob/main/docker-compose.yaml), based on [Air](https://github.com/air-verse/air) (for live reloading)
- a ready to use [Dockerfile](https://github.com/ankorstore/yokai-http-template/blob/main/Dockerfile) for production
- some examples of [handler](https://github.com/ankorstore/yokai-http-template/blob/main/internal/handler/example.go) and [test](https://github.com/ankorstore/yokai-http-template/blob/main/internal/handler/example_test.go) to get started

Expand Down Expand Up @@ -72,7 +72,7 @@ When you use the template, an example endpoint is provided on [http://localhost:
Welcome to http-app.
```

To ease development, [Air](https://github.com/cosmtrek/air) is watching any changes you perform on `Go code` or `config files` to perform hot reload.
To ease development, [Air](https://github.com/air-verse/air) is watching any changes you perform on `Go code` or `config files` to perform hot reload.

Let's rename your application to `gopher-api` by updating `app.name` in the configuration:

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/worker-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ the [worker application template](../getting-started/worker-application.md).
It provides:

- a ready to extend [Yokai](https://github.com/ankorstore/yokai) application, with the [worker](../modules/fxworker.md) module installed
- a ready to use [dev environment](https://github.com/ankorstore/yokai-worker-template/blob/main/docker-compose.yaml), based on [Air](https://github.com/cosmtrek/air) (for live reloading)
- a ready to use [dev environment](https://github.com/ankorstore/yokai-worker-template/blob/main/docker-compose.yaml), based on [Air](https://github.com/air-verse/air) (for live reloading)
- a ready to use [Dockerfile](https://github.com/ankorstore/yokai-worker-template/blob/main/Dockerfile) for production
- some examples of [worker](https://github.com/ankorstore/yokai-worker-template/blob/main/internal/worker/example.go) and [test](https://github.com/ankorstore/yokai-worker-template/blob/main/internal/worker/example_test.go) to get started

Expand Down Expand Up @@ -81,7 +81,7 @@ You can run `make logs` to see it in action:
INF running module=worker service=worker-app worker=example-worker workerExecutionID=346775a2-6be5-43c3-907f-100a986cb2dc
```

To ease development, [Air](https://github.com/cosmtrek/air) is watching any changes you perform on `Go code`
To ease development, [Air](https://github.com/air-verse/air) is watching any changes you perform on `Go code`
or `config files` to perform hot reload.

Let's change:
Expand Down

0 comments on commit f42bf67

Please sign in to comment.