Skip to content

Commit ab30269

Browse files
authored
doc(main): Updated documentation (#339)
1 parent f117843 commit ab30269

File tree

3 files changed

+16
-13
lines changed

3 files changed

+16
-13
lines changed

docs/demos/grpc-application.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ This demo application is following the [recommended project layout](https://go.d
2222

2323
- `cmd/`: entry points
2424
- `configs/`: configuration files
25-
- `internal/`:
26-
- `interceptor/`: gRPC interceptors
27-
- `service/`: gRPC services
28-
- `bootstrap.go`: bootstrap
29-
- `register.go`: dependencies registration
25+
- `internal/`:
26+
- `api/`: gRPC API
27+
- `interceptor/`: gRPC interceptors
28+
- `service/`: gRPC services
29+
- `bootstrap.go`: bootstrap
30+
- `register.go`: dependencies registration
3031
- `proto/`: protobuf definition and stubs
3132

3233
### Makefile
@@ -76,7 +77,7 @@ This demo application also provides [reflection](../modules/fxgrpcserver.md#refl
7677

7778
### Authentication
7879

79-
This demo application provides example [authentication interceptors](https://github.com/ankorstore/yokai-showroom/tree/main/grpc-demo/internal/interceptor/authentication.go).
80+
This demo application provides example [authentication interceptors](https://github.com/ankorstore/yokai-showroom/tree/main/grpc-demo/internal/api/interceptor/authentication.go).
8081

8182
You can enable authentication in the application [configuration file](https://github.com/ankorstore/yokai-showroom/tree/main/grpc-demo/configs/config.yaml) with `config.authentication.enabled=true`.
8283

docs/demos/http-application.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@ This demo application is following the [recommended project layout](https://go.d
2727
- `migrations/`: database migrations
2828
- `seeds/`: database seeds
2929
- `internal/`:
30-
- `handler/`: HTTP handlers
31-
- `middleware/`: HTTP middlewares
32-
- `model/`: models
33-
- `repository/`: models repositories
34-
- `service/`: services
30+
- `api/`: HTTP API
31+
- `handler/`: HTTP handlers
32+
- `middleware/`: HTTP middlewares
33+
- `domain/`: domain
34+
- `model.go`: gophers model
35+
- `repository.go`: gophers repository
36+
- `service.go`: gophers service
3537
- `bootstrap.go`: bootstrap
3638
- `register.go`: dependencies registration
3739
- `router.go`: routing registration
@@ -81,7 +83,7 @@ On [http://localhost:8080](http://localhost:8080), you can use:
8183

8284
### Authentication
8385

84-
This demo application provides an example [authentication middleware](https://github.com/ankorstore/yokai-showroom/blob/main/http-demo/internal/middleware/authentication.go).
86+
This demo application provides an example [authentication middleware](https://github.com/ankorstore/yokai-showroom/blob/main/http-demo/internal/api/middleware/authentication.go).
8587

8688
You can enable authentication in the application [configuration file](https://github.com/ankorstore/yokai-showroom/blob/main/http-demo/configs/config.yaml) with `config.authentication.enabled=true`.
8789

docs/modules/fxmcpserver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -694,7 +694,7 @@ func TestMCPPing(t *testing.T) {
694694
695695
// assertion on the metrics registry
696696
expectedMetric := `
697-
# HELP mcp_server_requests_total Number of processed HTTP requests
697+
# HELP mcp_server_requests_total Number of processed MCP requests
698698
# TYPE mcp_server_requests_total counter
699699
mcp_server_requests_total{method="ping",status="success",target=""} 1
700700
`

0 commit comments

Comments
 (0)