Use `doc.go` for documentation

aau-network-security / riotpot

IoT and Operational Technology Honeypot

MIT License

105 stars 28 forks source link

Use `doc.go` for documentation #90

Open RicYaben opened 1 year ago

RicYaben commented 1 year ago

We should use the format doc.go to add descriptions to packages. This approach can be seen in bigger projects (e.g. Kubernetes) that start to see the complexities of the Golang project layout, and the Golang documentation official page Godoc