Mini-Vending Go Services¶
Internal documentation portal for the Mini-Vending microservice platform.
Quick links¶
| Section | Description |
|---|---|
| Architecture | System overview, Clean Architecture, module structure |
| API Reference | gRPC/REST API docs per service (auto-generated from proto) |
| Database | Schema docs per service (auto-generated from PostgreSQL) |
| Packages | Shared Go package reference (auto-generated from source) |
How this portal is generated¶
All documentation is auto-generated from source code and schemas:
- API docs —
protoc-gen-doc+protoc-gen-openapiv2from.protofiles - DB docs —
tblsfrom live PostgreSQL schemas - Package docs —
gomarkdocfrom Go doc comments
Run make docs from the repository root to regenerate everything, or make docs-serve to preview locally.