- [ ] Improved proto / [gRPC Gateway OpenAPI](https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/) docs - [ ] Expand documentation with real-world specifications / reference guides / articles describing concepts - Improve this repository being a good learning / reference resource (as intended) - Awesome resource (already referenced describing some concepts): [microservices.io](https://microservices.io/) by Chris Richardson - Similar concepts implemented in Stocklet: - Database per service ([Independently deployable](https://microservices.io/post/architecture/2022/05/04/microservice-architecture-essentials-deployability.html) and [Loosely coupled](https://microservices.io/post/architecture/2023/03/28/microservice-architecture-essentials-loose-coupling.html) services) - [Domain event](https://microservices.io/patterns/data/domain-event.html) - [Event sourcing](https://microservices.io/patterns/data/event-sourcing.html) - [Transactional outbox](https://microservices.io/patterns/data/transactional-outbox.html) - [Remote Procedure Invocation](https://microservices.io/patterns/communication-style/rpi.html) - [Messaging](https://microservices.io/patterns/communication-style/messaging.html) - [API gateway](https://microservices.io/patterns/apigateway.html) - [Distributed tracing](https://microservices.io/patterns/observability/distributed-tracing.html) - [OAuth 2.0 Specification](https://www.rfc-editor.org/rfc/rfc6749) and [OpenID Connect Specification](https://openid.net/specs/openid-connect-core-1_0.html) (wip: feat/openid-connect) - Documentation showing examples of current request tracing (implemented OpenTelemetry) - expand with exporting to a Grafana UI - [golang-standards/project-layout](https://github.com/golang-standards/project-layout) - [ ] Documentation for recommended IDE setups / plugins - VSCode Plugins - `.vscode/extensions.json` - "Buf" - protobuf linting (bufbuild.vscode-buf) - "Go" - golang support (golang.go) - "Makefile Tools" - makefile support (ms-vscode.makefile-tools) - "markdownlint" - linting and style compliance for markdown (davidanson.vscode-markdownlint) - Neovim / LazyVim plugins - `docs/IDE_SUGGESTIONS.md`
Improved proto / gRPC Gateway OpenAPI docs
Expand documentation with real-world specifications / reference guides / articles describing concepts
Documentation for recommended IDE setups / plugins
.vscode/extensions.jsondocs/IDE_SUGGESTIONS.md