Skip to content

docs(sdk): add Go SDK documentation and CI job (3/4)#11

Open
rhuss wants to merge 4 commits into
go-sdk-2-auth-fakesfrom
go-sdk-3-docs-ci
Open

docs(sdk): add Go SDK documentation and CI job (3/4)#11
rhuss wants to merge 4 commits into
go-sdk-2-auth-fakesfrom
go-sdk-3-docs-ci

Conversation

@rhuss

@rhuss rhuss commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

Add Fern MDX documentation and Go CI job for the SDK.

Part 3 of 4 for #2044. Depends on PR 2 (auth/fakes).

What's Included

  • Fern MDX pages: getting-started, architecture, error-handling, authentication under docs/sdks/go/
  • Navigation: SDKs section added to docs/index.yml
  • CI job: Go job added to branch-checks.yml (lint, build, test, proto check)
  • Mise task: tasks/go.toml with go:proto, go:lint, go:build, go:test

7 files

@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 74e5168c-b0d0-4c4b-b420-38d22fa5f27a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch go-sdk-3-docs-ci

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@rhuss
rhuss requested a review from Copilot July 11, 2026 10:43
@rhuss
rhuss marked this pull request as ready for review July 11, 2026 10:43
devin-ai-integration[bot]

This comment was marked as resolved.

This comment was marked as resolved.

@rhuss
rhuss force-pushed the go-sdk-2-auth-fakes branch from ce2b841 to 798a017 Compare July 11, 2026 10:50
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 0132631 to 1f45986 Compare July 11, 2026 10:50
@rhuss
rhuss force-pushed the go-sdk-2-auth-fakes branch from 798a017 to 8ec90d2 Compare July 11, 2026 10:58
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 1f45986 to 55985e2 Compare July 11, 2026 10:58
@rhuss
rhuss force-pushed the go-sdk-2-auth-fakes branch from 8ec90d2 to b5db057 Compare July 11, 2026 11:05
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 55985e2 to 1cfa90a Compare July 11, 2026 11:05
@rhuss
rhuss force-pushed the go-sdk-2-auth-fakes branch from b5db057 to edbf3ed Compare July 11, 2026 11:11
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 1cfa90a to 846fdae Compare July 11, 2026 11:11
Add Fern MDX documentation pages (getting-started, architecture,
error-handling, authentication), wire into docs navigation, create
go:proto mise task, and add Go job to branch-checks CI workflow.

Part 3 of 4 for issue NVIDIA#2044.
Assisted-By: 🤖 Claude Code

Signed-off-by: Roland Huß <rhuss@redhat.com>
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 846fdae to f56a752 Compare July 11, 2026 11:16
devin-ai-integration[bot]

This comment was marked as resolved.

Applied fixes from bot review comments:
- Comments #3563986610-3563986676: fix SPDX copyright year to 2025-2026
- Comment #3563988719: use sb.Status.Phase instead of sb.Status
- Comment #3563988730: fix Create API to use (name, spec, labels) signature
- Comment #3563988737: fix Exec.Run to use []string command and cast Stdout
- Comment #3563988745: fix StaticToken import to v1 package
- Comment #3563988756: fix OIDC refresh description accuracy
- Comment #3564030817: fix oidc import path in auth docs

Assisted-By: 🤖 Claude Code
Signed-off-by: Roland Huß <rhuss@redhat.com>
devin-ai-integration[bot]

This comment was marked as resolved.

rhuss added a commit that referenced this pull request Jul 11, 2026
Lower the minimum Go version to 1.24.0, matching PR #9.

Assisted-By: 🤖 Claude Code
rhuss added a commit that referenced this pull request Jul 11, 2026
Lower the minimum Go version to 1.24.0, matching PR #9.

Assisted-By: 🤖 Claude Code
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 52518c3 to 94dda5c Compare July 11, 2026 13:27
Lower the minimum Go version to 1.24.0, matching PR #9.

Assisted-By: 🤖 Claude Code
@rhuss
rhuss force-pushed the go-sdk-2-auth-fakes branch from 552e801 to db75560 Compare July 11, 2026 13:28
@rhuss
rhuss force-pushed the go-sdk-3-docs-ci branch from 94dda5c to df5ddb4 Compare July 11, 2026 13:28
devin-ai-integration[bot]

This comment was marked as resolved.

Applied fixes from bot review comments:
- Comment #3564062168: fix TLS field names (InsecureSkipVerify->Insecure, CACertFile->CAFile)
- Comment #3564062197: fix error code constant names (NotFound->ErrorNotFound, etc.)
- Comment #3564062212: fix retry field name (Backoff->InitialWait) in error-handling
- Comment #3564062234: fix retry field name (Backoff->InitialWait) in getting-started
- Comment #3564062266: fix error codes table (remove Unauthenticated, add missing codes)
- Comment #3564062301: add missing Config() accessor to sub-clients table
- Comment #3564256837: update Go version requirement from 1.25 to 1.24

Assisted-By: 🤖 Claude Code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants