add Go sdk doc links

jyecusch · jyecusch · commit 08a848335398 · 2025-03-13T15:14:40.000+11:00
diff --git a/docs/reference/go/api/api-delete.mdx b/docs/reference/go/api/api-delete.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set
 
 # Go - Api.Delete()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register an API route and set a specific HTTP DELETE handler on that route.
 
 <Note>
diff --git a/docs/reference/go/api/api-get.mdx b/docs/reference/go/api/api-get.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set
 
 # Go - Api.Get()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register an API route and set a specific HTTP GET handler on that route.
 
 <Note>
diff --git a/docs/reference/go/api/api-patch.mdx b/docs/reference/go/api/api-patch.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set
 
 # Go - Api.Patch()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register an API route and set a specific HTTP PATCH handler on that route.
 
 <Note>
diff --git a/docs/reference/go/api/api-post.mdx b/docs/reference/go/api/api-post.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set
 
 # Go - Api.Post()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register an API route and set a specific HTTP POST handler on that route.
 
 <Note>
diff --git a/docs/reference/go/api/api-put.mdx b/docs/reference/go/api/api-put.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register an API route and set
 
 # Go - Api.Put()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register an API route and set a specific HTTP PUT handler on that route.
 
 <Note>
diff --git a/docs/reference/go/api/api-route-all.mdx b/docs/reference/go/api/api-route-all.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a single handler for
 
 # Go - Api.Route.All()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on the route.
 
 ```go
diff --git a/docs/reference/go/api/api-route-delete.mdx b/docs/reference/go/api/api-route-delete.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP DE
 
 # Go - Api.Route.Delete()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register a handler for HTTP DELETE requests to the route.
 
 ```go
diff --git a/docs/reference/go/api/api-route-get.mdx b/docs/reference/go/api/api-route-get.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP GE
 
 # Go - Api.Route.Get()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register a handler for HTTP GET requests to the route.
 
 ```go
diff --git a/docs/reference/go/api/api-route-patch.mdx b/docs/reference/go/api/api-route-patch.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP PA
 
 # Go - Api.Route.Patch()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register a handler for HTTP PATCH requests to the route.
 
 ```go
diff --git a/docs/reference/go/api/api-route-post.mdx b/docs/reference/go/api/api-route-post.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP PO
 
 # Go - Api.Route.Post()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register a handler for HTTP POST requests to the route.
 
 ```go
diff --git a/docs/reference/go/api/api-route-put.mdx b/docs/reference/go/api/api-route-put.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a handler for HTTP PU
 
 # Go - Api.Route.Put()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Register a handler for HTTP PUT requests to the route.
 
 ```go
diff --git a/docs/reference/go/api/api-route.mdx b/docs/reference/go/api/api-route.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new route (path) wit
 
 # Go - Api.Route()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Creates a new route (path) within an API.
 
 ```go
diff --git a/docs/reference/go/api/api.mdx b/docs/reference/go/api/api.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create APIs with the Nitric Go
 
 # Go - NewApi()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about APIs in
+  Nitric start with the [API docs](/api).
+</Note>
+
 Creates a new HTTP API.
 
 ```go
diff --git a/docs/reference/go/batch/job-handler.mdx b/docs/reference/go/batch/job-handler.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Register a job handler to with
 
 # Go - Job.Handler()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Batch
+  Services in Nitric start with the [Batch Services docs](/batch).
+</Note>
+
 Job handlers are the code that is run when a job request is submitted. These handlers should be written in a separate file to your services.
 
 ```go
diff --git a/docs/reference/go/batch/job-submit.mdx b/docs/reference/go/batch/job-submit.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Submit a batch job request wit
 
 # Go - Job.Submit()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Batch
+  Services in Nitric start with the [Batch Services docs](/batch).
+</Note>
+
 Jobs may be submitted from Nitric `services` or other `batches` using the `submit` method on the job reference. When submitting a job you can provide a payload that will be passed to the job handler function.
 
 ```go
diff --git a/docs/reference/go/batch/job.mdx b/docs/reference/go/batch/job.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Create Batch Jobs with the Nit
 
 # Go - NewJob()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Batch
+  Services in Nitric start with the [Batch Services docs](/batch).
+</Note>
+
 Creates a new Batch Job.
 
 ```go
diff --git a/docs/reference/go/index.mdx b/docs/reference/go/index.mdx
@@ -8,6 +8,12 @@ This SDK reference provides documentation for the functions and methods in Nitri
 
 The library provides the ability to define and interact with cloud resources, as well as build application logic like functions/handlers.
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. If you're just learning
+  Nitric, we recommend starting with the [Quickstart](/get-started/quickstart)
+  guide.
+</Note>
+
 ## Installation
 
 If you used a Nitric starter template for Go to scaffold your project, then the `github.com/nitrictech/go-sdk` dependency will already be included in the dependencies in your `go.mod` file. Using starter templates is the recommended installation option since it ensures the other files and configuration needed are also set up.
diff --git a/docs/reference/go/keyvalue/keyvalue-delete.mdx b/docs/reference/go/keyvalue/keyvalue-delete.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Delete key from a key value st
 
 # Go - Kv.Delete()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
+</Note>
+
 Delete key from a key value store.
 
 ```go
diff --git a/docs/reference/go/keyvalue/keyvalue-get.mdx b/docs/reference/go/keyvalue/keyvalue-get.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Get a value from a key value s
 
 # Go - Kv.Get()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
+</Note>
+
 Get a value from a key value store.
 
 ```go
diff --git a/docs/reference/go/keyvalue/keyvalue-keys.mdx b/docs/reference/go/keyvalue/keyvalue-keys.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Retrieve all or some of the ke
 
 # Go - Kv.Keys()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
+</Note>
+
 Return an async iterable of keys in the store.
 
 ```go
diff --git a/docs/reference/go/keyvalue/keyvalue-set.mdx b/docs/reference/go/keyvalue/keyvalue-set.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Store a key value pair in a ke
 
 # Go - Kv.Set()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
+</Note>
+
 Store a key value pair in a key value store.
 
 ```go
diff --git a/docs/reference/go/keyvalue/keyvalue.mdx b/docs/reference/go/keyvalue/keyvalue.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new key value store
 
 # Go - NewKv()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Key/Value Stores in Nitric start with the [Key/Value Store docs](/keyvalue).
+</Note>
+
 Creates a new key value store to get, set, and delete key value pairs.
 
 ```go
diff --git a/docs/reference/go/queues/queue-dequeue.mdx b/docs/reference/go/queues/queue-dequeue.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Dequeue messages."
 
 # Go - Queue.Dequeue()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Queues
+  in Nitric start with the [Async Messaging docs](/messaging#queues).
+</Note>
+
 Dequeue messages.
 
 ```go
diff --git a/docs/reference/go/queues/queue-enqueue.mdx b/docs/reference/go/queues/queue-enqueue.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Send messages to a queue."
 
 # Go - Queue.Enqueue()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Queues
+  in Nitric start with the [Async Messaging docs](/messaging#queues).
+</Note>
+
 Send messages to a queue.
 
 ```go
diff --git a/docs/reference/go/queues/queue.mdx b/docs/reference/go/queues/queue.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new Queue to send an
 
 # Go - NewQueue()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Queues
+  in Nitric start with the [Async Messaging docs](/messaging#queues).
+</Note>
+
 Creates a new Queue to send and receive asynchronous tasks.
 
 ```go
diff --git a/docs/reference/go/schedule/schedule-every.mdx b/docs/reference/go/schedule/schedule-every.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go  library - Sets the frequency and one or
 
 # Go - Schedule.Every()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Schedules in Nitric start with the [Schedule docs](/schedules).
+</Note>
+
 Sets the frequency and one or many handlers to be triggered.
 
 ```go
diff --git a/docs/reference/go/schedule/schedule.mdx b/docs/reference/go/schedule/schedule.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a new Schedule to run
 
 # Go - NewSchedule()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about
+  Schedules in Nitric start with the [Schedule docs](/schedules).
+</Note>
+
 Creates a new Schedule to run a function on a defined frequency.
 
 ```go
diff --git a/docs/reference/go/secrets/secret-access-version.mdx b/docs/reference/go/secrets/secret-access-version.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Retrieves the value from a ver
 
 # Go - Secret.AccessVersion()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Secrets
+  in Nitric start with the [Secrets docs](/secrets).
+</Note>
+
 Retrieves the value from a version of a secret.
 
 ```go
diff --git a/docs/reference/go/secrets/secret-access.mdx b/docs/reference/go/secrets/secret-access.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Returns a reference to the lat
 
 # Go - Secret.Access()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Secrets
+  in Nitric start with the [Secrets docs](/secrets).
+</Note>
+
 Returns a the value of the latest iteration of a secret.
 
 ```go
diff --git a/docs/reference/go/secrets/secret-put.mdx b/docs/reference/go/secrets/secret-put.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Store a new secret value"
 
 # Go - Secret.Put()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Secrets
+  in Nitric start with the [Secrets docs](/secrets).
+</Note>
+
 Store a new secret value.
 
 ```go
diff --git a/docs/reference/go/secrets/secret.mdx b/docs/reference/go/secrets/secret.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a reference to a secre
 
 # Go - NewSecret()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about Secrets
+  in Nitric start with the [Secrets docs](/secrets).
+</Note>
+
 Creates a reference to a secret in the secrets manager.
 
 ```go
diff --git a/docs/reference/go/sql/sql-connection-string.mdx b/docs/reference/go/sql/sql-connection-string.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Returns the connection string
 
 # Go - SqlDatabase.ConnectionString()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about SQL
+  Databases in Nitric start with the [SQL docs](/sql).
+</Note>
+
 Returns the connection string for a SQL database at runtime.
 
 ```go
diff --git a/docs/reference/go/sql/sql.mdx b/docs/reference/go/sql/sql.mdx
@@ -4,6 +4,11 @@ description: "Reference for Nitric's Go library - Creates a reference to a SQL d
 
 # Go - NewSqlDatabase()
 
+<Note>
+  This is reference documentation for the Nitric Go SDK. To learn about SQL
+  Databases in Nitric start with the [SQL docs](/sql).
+</Note>
+
 Creates a reference to a SQL database.
 
 ```go
diff --git a/docs/reference/go/storage/bucket-delete.mdx b/docs/reference/go/storage/bucket-delete.mdx
diff --git a/docs/reference/go/storage/bucket-downloadurl.mdx b/docs/reference/go/storage/bucket-downloadurl.mdx
diff --git a/docs/reference/go/storage/bucket-listfiles.mdx b/docs/reference/go/storage/bucket-listfiles.mdx
diff --git a/docs/reference/go/storage/bucket-on.mdx b/docs/reference/go/storage/bucket-on.mdx
diff --git a/docs/reference/go/storage/bucket-read.mdx b/docs/reference/go/storage/bucket-read.mdx
diff --git a/docs/reference/go/storage/bucket-uploadurl.mdx b/docs/reference/go/storage/bucket-uploadurl.mdx
diff --git a/docs/reference/go/storage/bucket-write.mdx b/docs/reference/go/storage/bucket-write.mdx
diff --git a/docs/reference/go/storage/bucket.mdx b/docs/reference/go/storage/bucket.mdx
diff --git a/docs/reference/go/topic/topic-publish.mdx b/docs/reference/go/topic/topic-publish.mdx
diff --git a/docs/reference/go/topic/topic-subscribe.mdx b/docs/reference/go/topic/topic-subscribe.mdx
diff --git a/docs/reference/go/topic/topic.mdx b/docs/reference/go/topic/topic.mdx
diff --git a/docs/reference/go/websocket/websocket-close.mdx b/docs/reference/go/websocket/websocket-close.mdx
diff --git a/docs/reference/go/websocket/websocket-on.mdx b/docs/reference/go/websocket/websocket-on.mdx
diff --git a/docs/reference/go/websocket/websocket-send.mdx b/docs/reference/go/websocket/websocket-send.mdx
diff --git a/docs/reference/go/websocket/websocket.mdx b/docs/reference/go/websocket/websocket.mdx
