Skip to content

docs: Fix Go SDK README and guide code samples, versions, and links - #204

Open
promptless[bot] wants to merge 2 commits into
mainfrom
promptless/sdk-docs-review
Open

promptless[bot] wants to merge 2 commits into
mainfrom
promptless/sdk-docs-review

Conversation

@promptless

@promptless promptless Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Open in Promptless

Why

The Go SDK docs have samples that don't compile against the current SDK, an outdated minimum Go version, and broken anchors and links.

Goal

  • README.md: raise the Go floor to 1.25.0 to match v2/go.mod. Make the Quickstart a single program that runs. Add the required options argument to 18 calls (Insert, Query, Tokenize, Delete, UploadFile, DeidentifyText, ReidentifyText, DeidentifyFile, GetDetectRun). Fix a broken table-of-contents anchor and a broken in-text link to the bearer-tokens section.
  • docs/advanced_initialization.md: fix a "Python SDK" copy error, := typos, a missing fmt import, and add client error handling so the sample compiles and reports initialization errors.
  • docs/auth_credentials.md: correct the credential precedence order. docs/api_reference.md and docs/migrate_to_v2.md: correct the casing of response keys. docs/migrate_to_v2.md: fix a dead CHANGELOG link.
  • README-v1.md: fix compile and runtime errors in the samples, such as := typos, missing struct commas, a ConnectionConfig field type mismatch, an undefined variable, a missing import, an invalid LogLevel selector, and literal types that panic on the v1 type assertions.
  • Not in this PR: the Go version pins in samples/v2/go.mod and CI, the column name in the Query example, which the team should confirm, and stale pre-Fern docs.skyflow.com URLs.

Testing

  • Every corrected identifier, signature, default, version, and link target was checked against the SDK source, build files, and samples in this repository at the current main commit. Review comments on this PR link each correction to the source line that supports it.
  • No SDK code, samples, or build files changed. Builds, tests, and installers were not run.
  • Vale prose checks report no new findings in the changed passages.

Trigger Events

Comment thread README.md
@github-actions

Copy link
Copy Markdown

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

Comment thread README.md
Comment thread README.md
@github-actions

Copy link
Copy Markdown

GoSec Findings: No issues found, Good to merge.

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

Comment thread README.md
@github-actions

Copy link
Copy Markdown

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

@github-actions

Copy link
Copy Markdown

GoSec Findings: No issues found, Good to merge.

@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README-v1.md
Comment thread README-v1.md
Comment thread README-v1.md
Comment thread docs/auth_credentials.md
Comment thread docs/api_reference.md
Comment thread docs/api_reference.md
Comment thread docs/migrate_to_v2.md
Comment thread docs/migrate_to_v2.md
Comment thread docs/advanced_initialization.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants