chore: add doc.go to several packages

This helps with navigating pkg.go.dev for Gordian.

gcrypto/doc.go

@@ -0,0 +1,2 @@
+// Package gcrypto contains cryptographic primitives for the Gordian engine.
+package gcrypto

tm/tmcodec/doc.go

@@ -0,0 +1,3 @@
+// Package tmcodec contains types for marshalling and unmarshalling consensus messages,
+// without being coupled to any particular serialization scheme.
+package tmcodec

tm/tmcodec/tmjson/doc.go

@@ -0,0 +1,6 @@
+// Package tmjson contains types satisfying the [tmcodec] interfaces
+// that serializing to and deserialize from JSON.
+//
+// These types are simple to work with, simple to maintain, and easy to read.
+// You can certainly get better performance with other serialization methods.
+package tmjson

tm/tmengine/doc.go

@@ -0,0 +1,3 @@
+// Package tmengine contains the [Engine] and its supporting types
+// which are used to actually create a consensus engine.
+package tmengine

tm/tmp2p/doc.go

@@ -0,0 +1,2 @@
+// Package tmp2p contains high-level interfaces for the peer-to-peer layer for [tmengine].
+package tmp2p

tm/tmp2p/tmlibp2p/doc.go

@@ -0,0 +1,6 @@
+// Package tmlibp2p contains implementations of the [tmp2p] interfaces
+// using [github.com/libp2p/go-libp2p].
+//
+// Note that this package will likely be moved to its own module
+// in a separate git repository, in the future.
+package tmlibp2p

tm/tmp2p/tmlibp2p/tmlibp2ptest/doc.go

@@ -0,0 +1,4 @@
+// Package tmlibp2ptest provides the [Network] type
+// that is useful for tests that need to instantiate
+// a Gordian peer-to-peer network backed by [tmlibp2p].
+package tmlibp2ptest

tm/tmp2p/tmp2ptest/doc.go

@@ -0,0 +1,3 @@
+// Package tmp2ptest contains compliance tests for tmp2p implementations,
+// and it also provides some other types that are useful in tests.
+package tmp2ptest

tm/tmstore/tmstoretest/doc.go

@@ -0,0 +1,4 @@
+// Package tmstoretest contains the compliance tests for implementations of the [tmstore] interfaces.
+//
+// Refer to [github.com/gordian-engine/gordian/tm/tmmemstore] for examples of calling the compliance tests.
+package tmstoretest