Layout
The layout.md document aims to describe the layout of the repo and overall general architecture of the service for new
contributors. As this document was created from a template, it is up to the service owner to create a valuable
layout.md.
Some useful information to capture in a layout.md may include the following:
- Folder directory descriptions
- Useful files for new contributor to aware of
- High level overview of the service architecture
For example, in the readme.md of the root of the service, the following captures the above pretty well:
This is a pretty bare-bones GRPC service. It's compiled from proto(s), and consumed the (alpha) SDK to run smoothly.
curious files:
- [proto/gossip.proto](proto/gossip.proto): the proto src spec
- [protocompile.sh](protocompile.sh): naive proto compile script. run this to rebuild protos.
- [main.go](main.go): illustrates bootstrapping a GRPC service (and dependencies) using the SDK.
- [service/service.go](service/service.go): concrete implement for generated proto server interface.
