Minor improvements to docs (#288)

A couple of hyperlinks and fixed a typo
transparency-dev · Nov 4, 2024 · 32dc3f4 · 32dc3f4
1 parent 329e69f
commit 32dc3f4
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/api/layout/paths.go b/api/layout/paths.go
@@ -14,7 +14,9 @@
 
 // Package layout contains routines for specifying the path layout of Tessera logs,
 // which is really to say that it provides functions to calculate paths used by the
-// tlog-tiles API: https://github.com/C2SP/C2SP/blob/main/tlog-tiles.md
+// [tlog-tiles API].
+//
+// [tlog-tiles API]: https://c2sp.org/tlog-tiles
 package layout
 
 import (

diff --git a/api/state.go b/api/state.go
@@ -12,7 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package api contains the tiles definitions from the tlog-tiles spec.
+// Package api contains the tiles definitions from the [tlog-tiles API].
+//
+// [tlog-tiles API]: https://c2sp.org/tlog-tiles
 package api
 
 import (

diff --git a/client/client.go b/client/client.go
@@ -13,7 +13,9 @@
 // limitations under the License.
 
 // Package client provides client support for interacting with logs that
-// uses the tlog-tiles API.
+// uses the [tlog-tiles API].
+//
+// [tlog-tiles API]: https://c2sp.org/tlog-tiles
 package client
 
 import (

diff --git a/ctonly/ct.go b/ctonly/ct.go
@@ -32,7 +32,7 @@
 // Package ctonly has support for CT Tiles API.
 //
 // This code should not be reused outside of CT.
-// Most of this code came from Filipo's Sunlight implementation of https://c2sp.org/ct-static-api.
+// Most of this code came from Filippo's Sunlight implementation of https://c2sp.org/ct-static-api.
 package ctonly
 
 import (