Repository navigation
docs: add Go to SDK reference formats and document mintlify-go-extractor - #8021
Merged
Merged
Conversation
Co-authored-by: brandon <brandon@dreamthinkbuild.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Collaborator
|
you can ignore the failing CI. I think I know what broke it and am putting up a fix |
ethanpalm
approved these changes
Oct 23, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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):gorow;mintlify-go-extractorproduces a JSON artifact file.go get -tool(Go 1.24+), and the prebuilt release binaries;internalpackages and commands skipped) and the common flags (-comments=godoc,-exclude,-goos/-goarch/-tags), with a link to the README for the rest.format: addsgoto the field's list of values.packageto the symbol kinds;type,interface,property, andpackage, withpackage openai.optionandtype option.RequestOptionexamples);namespacefield, which only Go targets use.gowith the single-file formats that accept a direct file URL.Other pages:
organize/navigation.mdx: addsgoto the list ofsdkformats.agent-context/context/skills/mintlify/reference/navigation.mdnow listsgo, with the extractor command.es/,fr/, andzh/, matching how earlier SDK reference PRs (Describe Javadoc kind grouping in SDK reference navigation #7851, Translate content: remove object form example from SDK reference setup #6989) kept the translations in sync.The frontmatter examples were checked against how
@mintlify/scrapingresolves Go targets: package targets are the package name plus a directory path, and qualified names match by suffix. The commands were run with the publishedv0.1.0against blockaid-client-go, openai-go, cohere-go, and go-github.For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Checks run
mint broken-links: no broken linkssdkin the description and thetypescriptJSON value) are already onmainagent-contexttests pass.npm run checkfails identically onmainbecauseskill.mdis out of date, which is unrelated to this changeNote
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.