Skip to content

docs: add Go to SDK reference formats and document mintlify-go-extractor - #8021

Merged
brandonmcconnell merged 1 commit into
mainfrom
cursor/go-sdk-reference-docs-f090
Oct 23, 2026
Merged

brandonmcconnell merged 1 commit into
mainfrom
cursor/go-sdk-reference-docs-f090

Conversation

@brandonmcconnell

@brandonmcconnell brandonmcconnell commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Documentation changes

Documents Go as the sixth SDK reference format ("format": "go"), which shipped in mintlify/mint#13001 and mintlify/mint#13002, along with the public extractor at mintlify/mintlify-go-extractor (v0.1.0).

SDK reference setup (api-playground/sdk-reference-setup.mdx):

  • Formats table: adds a go row; mintlify-go-extractor produces a JSON artifact file.
  • Generate an artifact: adds a Go tab to the command group, plus a new "Go" subsection that covers:
    • why Mintlify ships an extractor for Go (Go's own tools produce text and HTML, not a machine-readable artifact);
    • running it from inside the module, with no dependencies downloaded and no credentials needed;
    • pinning it with go get -tool (Go 1.24+), and the prebuilt release binaries;
    • the defaults (Markdown comments, internal packages and commands skipped) and the common flags (-comments=godoc, -exclude, -goos/-goarch/-tags), with a link to the README for the rest.
  • format: adds go to the field's list of values.
  • Generated pages: describes Go output. Pages are grouped by package, each package has an overview page (README, doc comment, type and function index), each type and package-level function gets its own page, and type pages show fields, constructors, and methods.
  • Frontmatter:
    • adds package to the symbol kinds;
    • adds Go targeting guidance (type, interface, property, and package, with package openai.option and type option.RequestOption examples);
    • documents the object-form namespace field, which only Go targets use.
  • Remote sources: lists go with the single-file formats that accept a direct file URL.

Other pages:

The frontmatter examples were checked against how @mintlify/scraping resolves Go targets: package targets are the package name plus a directory path, and qualified names match by suffix. The commands were run with the published v0.1.0 against blockaid-client-go, openai-go, cohere-go, and go-github.


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts
  • Content follows the style guide

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Checks run

  • mint broken-links: no broken links
  • External links (repo, releases, README anchor, go.dev doc comment syntax) return 200
  • Vale on the English pages: the only remaining errors (sdk in the description and the typescript JSON value) are already on main
  • agent-context tests pass. npm run check fails identically on main because skill.md is out of date, which is unrelated to this change
Open in Web Open in Cursor 

Note

Low Risk
Documentation-only changes with no runtime or product code impact.

Reviewed by Cursor Bugbot for commit afe000e. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-authored-by: brandon <brandon@dreamthinkbuild.com>
@mintlify

mintlify Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Oct 23, 2026, 6:24 PM

@ethanpalm

Copy link
Copy Markdown
Collaborator

you can ignore the failing CI. I think I know what broke it and am putting up a fix

@brandonmcconnell
brandonmcconnell merged commit 36f2fe2 into main Oct 23, 2026
5 of 6 checks passed
@brandonmcconnell
brandonmcconnell deleted the cursor/go-sdk-reference-docs-f090 branch October 23, 2026 18:32

This branch was successfully deployed

1 active deployment
staging — afe000e8 Deployed Oct 23, 2026 by mintlify[bot]
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.

3 participants