docs: add Go SDK examples

Author: IlyaasK

.docs/code-example-guide.md

@@ -4,10 +4,10 @@ This guide defines the standards for code examples across the Kernel documentati
 
 ## General Principles
 
-1. **Complete and runnable**: Every code example should be complete enough to run as-is
+1. **Complete and runnable**: Every code example must be complete enough to run as-is
 2. **Consistent naming**: Use standardized variable names across all examples
 3. **No hardcoded credentials**: Never include API keys or credentials in examples
-4. **Multi-language support**: When applicable, show both TypeScript/JavaScript and Python examples
+4. **Multi-language support**: When applicable, show TypeScript/JavaScript, Python, and Go examples
 
 ## Variable Naming Conventions
 
@@ -27,6 +27,14 @@ This guide defines the standards for code examples across the Kernel documentati
 - Context: `context`
 - Page: `page`
 
+### Go
+- SDK client: `client`
+- Browser instance: `kernelBrowser`
+- Additional browsers: `kernelBrowser2`, etc.
+- Context: `ctx`
+- Session ID: `sessionID`
+- Invocation ID: `invocationID`
+
 ## Code Example Structure
 
 ### Minimal Example (Browser Creation)
@@ -55,6 +63,29 @@ kernel = Kernel()
 kernel_browser = kernel.browsers.create()
 print(kernel_browser.session_id)
 ```
+
+```go Go
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/kernel/kernel-go-sdk"
+)
+
+func main() {
+	ctx := context.Background()
+	client := kernel.NewClient()
+
+	kernelBrowser, err := client.Browsers.New(ctx, kernel.BrowserNewParams{})
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(kernelBrowser.SessionID)
+}
+```
 </CodeGroup>
 
 ### Full Example (With Browser Automation)
@@ -129,6 +160,16 @@ const kernel = new Kernel();
 kernel = Kernel()
 ```
 
+```go
+package main
+
+import "github.com/kernel/kernel-go-sdk"
+
+func main() {
+	_ = kernel.NewClient()
+}
+```
+
 The SDK automatically reads the API key from the `KERNEL_API_KEY` environment variable.
 
 ### ❌ Incorrect - Hardcoded credentials
@@ -145,6 +186,22 @@ kernel = Kernel(api_key="your-api-key")
 kernel = Kernel(api_key=os.getenv("KERNEL_API_KEY"))
 ```
 
+```go
+// DON'T DO THIS
+package main
+
+import (
+	"github.com/kernel/kernel-go-sdk"
+	"github.com/kernel/kernel-go-sdk/option"
+)
+
+func main() {
+	_ = kernel.NewClient(
+		option.WithAPIKey("your-api-key"),
+	)
+}
+```
+
 ## Feature-Specific Examples
 
 ### Simple Feature Toggle
@@ -171,6 +228,28 @@ kernel_browser = kernel.browsers.create(
     stealth=True,
 )
 ```
+
+```go Go
+package main
+
+import (
+	"context"
+
+	"github.com/kernel/kernel-go-sdk"
+)
+
+func main() {
+	ctx := context.Background()
+	client := kernel.NewClient()
+
+	_, err := client.Browsers.New(ctx, kernel.BrowserNewParams{
+		Stealth: kernel.Bool(true),
+	})
+	if err != nil {
+		panic(err)
+	}
+}
+```
 </CodeGroup>
 
 ### Feature with Configuration
@@ -197,10 +276,36 @@ kernel_browser = kernel.browsers.create(
     stealth=True
 )
 ```
+
+```go Go
+package main
+
+import (
+	"context"
+
+	"github.com/kernel/kernel-go-sdk"
+)
+
+func main() {
+	ctx := context.Background()
+	client := kernel.NewClient()
+
+	kernelBrowser, err := client.Browsers.New(ctx, kernel.BrowserNewParams{
+		Stealth: kernel.Bool(true),
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	_ = kernelBrowser
+}
+```
 </CodeGroup>
 
 ## App Development Examples
 
+Kernel app examples currently use TypeScript/JavaScript and Python. Add a Go version only after the Go SDK has documented app framework support and the snippet has been tested against that SDK.
+
 For Kernel app examples, follow this pattern:
 
 <CodeGroup>
@@ -299,17 +404,19 @@ finally:
 ### Indentation
 - TypeScript/JavaScript: 2 spaces
 - Python: 4 spaces
+- Go: tabs from `gofmt`
 
 ### String Quotes
 - TypeScript/JavaScript: Single quotes `'` (except for avoiding escaping)
 - Python: Double quotes `"`
+- Go: Double quotes `"`
 
 ### Line Length
 - Keep lines under 100 characters when possible
 - Break long parameter lists across multiple lines
 
 ### Comments
-- Use comments sparingly - code should be self-explanatory
+- Use comments sparingly; keep code self-explanatory
 - Add comments only for non-obvious logic or important context
 - Never add comments like "NEW CODE:" or similar meta-comments
 
@@ -340,6 +447,10 @@ Always use `<CodeGroup>` with proper language labels:
 ```python Python
 # Python code here
 ```
+
+```go Go
+// Go code here
+```
 </CodeGroup>
 ````
 
@@ -354,7 +465,9 @@ Before publishing a code example, verify:
 - [ ] Includes error handling (for full examples)
 - [ ] Includes cleanup code (for full examples)
 - [ ] Uses proper indentation and formatting
-- [ ] Both TypeScript and Python versions are provided (when applicable)
+- [ ] TypeScript/JavaScript, Python, and Go versions are provided (when applicable)
+- [ ] Go examples are formatted with `gofmt`
+- [ ] Go examples are tested against the actual Go SDK before publishing
 - [ ] Code has been tested or follows proven patterns
 
 ## Reference
@@ -363,4 +476,3 @@ See these files for examples:
 - `introduction/create.mdx` - Standard browser creation pattern
 - `apps/develop.mdx` - App development pattern
 - `browsers/file-io.mdx` - Complex automation example
-

README.md

@@ -11,31 +11,13 @@ This is the documentation for the Kernel platform. It's connected to [onkernel.c
 
 ## Code Snippets
 
-Code samples in the docs are generated from our OpenAPI spec so the examples stay in sync with the API. There are two ways the generator is invoked:
+Code samples in the docs are authored inline in MDX. Keep SDK examples aligned with the SDK repos, and follow the standards in `.docs/code-example-guide.md` when adding or editing examples.
 
-- Custom MDX tag: use `<OpenAPICodeGroup>get /api/v1/users</OpenAPICodeGroup>` (or omit the verb to use the default behavior).
+When you add Go examples:
 
-How the generator works (current behavior):
-
-- The script is `.github/scripts/generate_code_samples.ts` and is executed with Bun. It fetches the OpenAPI spec from the URL configured at the top of that script.
-- It reads `x-codeSamples` entries for each operation and extracts samples for TypeScript/JavaScript and Python. Samples are normalized and may be transformed by simple "overrides" (see the script for the override parsing and injection heuristics).
-- It writes snippet files under `snippets/openapi/` as MDX files containing a `<CodeGroup>` with the generated code fences. It also updates any MDX files under `apps/` and `browsers/` that contain the inline or tag forms by replacing them with the generated `<CodeGroup>` blocks.
-- The generator can produce a base snippet and additional variant snippets controlled by `.github/scripts/code_samples.config.json` (variants are keyed by `"method /path"`).
-- The script also removes stale snippet files matching the `-.mdx` suffix pattern.
-
-How it affects the repository:
-
-- New or updated files are created under `snippets/openapi/*.mdx`.
-- MDX pages in `apps/` and `browsers/` may be modified in-place to replace `<OpenAPICodeGroup>`/mustache tags with generated `<CodeGroup>` blocks.
-- A GitHub Action (`.github/workflows/generate_code_snippets.yaml`) runs the script on push (except to `main`), commits any changes, and pushes them to the `gh_action_generated_docs` branch so Mintlify can deploy the generated docs.
-
-Notes and gotchas:
-
-- The generator runs remotely against the OpenAPI URL defined in the script, so it needs network access and the spec to include `x-codeSamples` for useful output.
-- The override parsing and code injection are heuristic. Complex sample sources might not be transformed exactly as intended. See the script for details on how keys/`log` overrides are applied.
-- The GitHub Action installs Bun and runs the script; if you run it locally, install Bun and run `bun run .github/scripts/generate_code_samples.ts` from the repo root.
-
-Example: to add a snippet placeholder to a page, add `<OpenAPICodeGroup>get /api/v1/users</OpenAPICodeGroup>` and let the generator fill `snippets/openapi` and update the page during the next run.
+- Test the snippet against the actual Go SDK, usually from a sibling `../kernel-go-sdk` checkout.
+- Run `gofmt` on the extracted Go code before publishing.
+- Note the validation you ran in the pull request description.
 
 ## Local Development
 

apps/invoke.mdx

@@ -34,6 +34,33 @@ invocation = kernel.invocations.create(
 )
 print(invocation.id)
 ```
+
+```go Go
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/kernel/kernel-go-sdk"
+)
+
+func main() {
+	ctx := context.Background()
+	client := kernel.NewClient()
+
+	invocation, err := client.Invocations.New(ctx, kernel.InvocationNewParams{
+		ActionName: "analyze",
+		AppName:    "my-app",
+		Version:    "1.0.0",
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(invocation.ID)
+}
+```
 </CodeGroup>
 
 ### Asynchronous invocations
@@ -70,6 +97,34 @@ invocation = kernel.invocations.create(
 )
 print(invocation.id)
 ```
+
+```go Go
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/kernel/kernel-go-sdk"
+)
+
+func main() {
+	ctx := context.Background()
+	client := kernel.NewClient()
+
+	invocation, err := client.Invocations.New(ctx, kernel.InvocationNewParams{
+		Async:      kernel.Bool(true),
+		ActionName: "analyze",
+		AppName:    "my-app",
+		Version:    "1.0.0",
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(invocation.ID)
+}
+```
 </CodeGroup>
 
 ## Via CLI

apps/logs.mdx

@@ -21,6 +21,35 @@ from kernel import Kernel
 kernel = Kernel()
 logs = kernel.invocations.follow(invocation_id)
 ```
+
+```go Go
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/kernel/kernel-go-sdk"
+)
+
+func main() {
+	ctx := context.Background()
+	client := kernel.NewClient()
+
+	logs := client.Invocations.FollowStreaming(ctx, "inv_123", kernel.InvocationFollowParams{})
+	defer logs.Close()
+
+	for logs.Next() {
+		event := logs.Current()
+		if event.Event == "log" {
+			fmt.Println(event.Message)
+		}
+	}
+	if err := logs.Err(); err != nil {
+		panic(err)
+	}
+}
+```
 </CodeGroup>
 
 <Info>Log lines will be truncated to 64KiB. For large payloads write data to external storage and log a reference instead.</Info>