Skip to content

Mini-Vending Go Services

Internal documentation portal for the Mini-Vending microservice platform.

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 docsprotoc-gen-doc + protoc-gen-openapiv2 from .proto files
  • DB docstbls from live PostgreSQL schemas
  • Package docsgomarkdoc from Go doc comments

Run make docs from the repository root to regenerate everything, or make docs-serve to preview locally.