@@ -146,10 +176,12 @@ Crea un `Client` para llamar a la API.
La forma de cadena sigue el patrón `[source] kind name`. Si omites `source`, la página lo hereda de la configuración `sdk` de la pestaña o del grupo. La forma de cadena siempre hereda `format`, por lo que solo funciona en páginas bajo una pestaña o grupo con `sdk`. En cualquier otro caso, establece `sdk` como un objeto con los campos que se indican a continuación. Para métodos y propiedades, incluye el nombre del elemento superior, por ejemplo `method Client.getUser`.
+Para artefactos de Go, apunta a los structs y otros tipos definidos con `type`, a las interfaces con `interface`, a los campos de struct con `property` y a las páginas de resumen de paquete con `package`. Haz referencia a un paquete por su nombre, seguido de la ruta de su directorio para los paquetes anidados, como `package openai` o `package openai.option`. Añade el paquete al nombre de un símbolo, como `type option.RequestOption`, cuando más de un paquete tenga un símbolo con ese nombre.
+
Si omites `title` o `description`, Mintlify usa el título y la descripción generados para el símbolo.
- El tipo de símbolo: `class`, `interface`, `enum`, `function`, `type`, `variable`, `method` o `property`.
+ El tipo de símbolo: `package`, `class`, `interface`, `enum`, `function`, `type`, `variable`, `method` o `property`.
@@ -160,6 +192,10 @@ Si omites `title` o `description`, Mintlify usa el título y la descripción gen
Requerido para símbolos de tipo `method` y `property`. La clase, interfaz o tipo que lo contiene.
+
+ Para artefactos de Go, el paquete que contiene el símbolo, como `openai.option`. Úsalo cuando más de un paquete tenga un símbolo con el mismo nombre.
+
+
Sobrescribe el `format` heredado. Obligatorio cuando la página no está bajo una pestaña o grupo con `sdk`. Solo disponible en la forma de objeto.
@@ -174,7 +210,7 @@ Si omites `title` o `description`, Mintlify usa el título y la descripción gen
Establece `source` como una URL HTTPS para obtener el artefacto en tiempo de compilación en lugar de incluirlo en tu repositorio de documentación.
-Los formatos de archivo único (`typedoc`, `phpdoc`) aceptan una URL directa al archivo. Los formatos de directorio (`docfx`, `javadoc`, `sphinx`) aceptan un archivo zip. Los jars de Javadoc publicados en Maven Central funcionan sin necesidad de reempaquetarlos:
+Los formatos de archivo único (`typedoc`, `phpdoc`, `go`) aceptan una URL directa al archivo. Los formatos de directorio (`docfx`, `javadoc`, `sphinx`) aceptan un archivo zip. Los jars de Javadoc publicados en Maven Central funcionan sin necesidad de reempaquetarlos:
```json
{
diff --git a/es/organize/navigation.mdx b/es/organize/navigation.mdx
index f1b2a82752..2fd92ee0f6 100644
--- a/es/organize/navigation.mdx
+++ b/es/organize/navigation.mdx
@@ -608,7 +608,7 @@ Para obtener más información sobre cómo hacer referencia a endpoints de OpenA
## Referencias de SDK
## Générer un artefact
@@ -47,8 +48,35 @@ python -m sphinx -b json docs/source artifacts/json
phpdoc -d src -t artifacts --template=xml
```
+```bash Go
+go run github.com/mintlify/mintlify-go-extractor@latest -o go.json
+```
+
+
+ ### Go
+
+
+Les outils de documentation de Go produisent du texte et du HTML, pas un artefact lisible par une machine. Mintlify maintient donc [`mintlify-go-extractor`](https://github.com/mintlify/mintlify-go-extractor), une commande open source qui en génère un. Exécutez-la depuis n’importe quel emplacement de votre module Go. Elle lit les fichiers source de votre module avec la bibliothèque standard de Go : elle ne télécharge aucune dépendance, n’a besoin d’aucun identifiant et fonctionne avec les modules privés.
+
+Avec Go 1.24 ou une version ultérieure, épinglez l’extracteur dans le `go.mod` de votre module pour que chaque exécution utilise la même version :
+
+```bash
+go get -tool github.com/mintlify/mintlify-go-extractor@latest
+go tool mintlify-go-extractor -o go.json
+```
+
+Chaque [version](https://github.com/mintlify/mintlify-go-extractor/releases) inclut des binaires précompilés pour macOS, Linux et Windows.
+
+Par défaut, l’extracteur documente tous les packages du module, à l’exception des packages `internal` et des commandes, et lit les commentaires de documentation comme du Markdown, ce qu’écrivent les SDK générés (par exemple avec Stainless, Speakeasy ou Fern). Options courantes :
+
+- `-comments=godoc` : lit les commentaires de documentation avec la [syntaxe des commentaires de documentation](https://go.dev/doc/comment) de Go plutôt qu’en Markdown.
+- `-exclude` : ignore des packages, sous la forme d’une liste de motifs de package séparés par des virgules.
+- `-goos`, `-goarch`, `-tags` : choisissent la plateforme et les tags de build utilisés pour sélectionner les fichiers. La valeur par défaut est `linux/amd64`.
+
+Passez des motifs de package, comme `./option/...`, pour ne documenter qu’une partie du module. Consultez le [README de l’extracteur](https://github.com/mintlify/mintlify-go-extractor#readme) pour la liste complète des options.
+
## Remplir automatiquement les pages SDK
@@ -94,7 +122,7 @@ Un groupe avec `sdk` peut aussi lister des `pages` que vous rédigez vous-même.
- L’outil de documentation qui a produit l’artefact : `typedoc`, `docfx`, `javadoc`, `sphinx` ou `phpdoc`.
+ L’outil de documentation qui a produit l’artefact : `typedoc`, `docfx`, `javadoc`, `sphinx`, `phpdoc` ou `go`.
@@ -121,6 +149,8 @@ Pour les artefacts TypeDoc, Mintlify suit l’organisation que vous définissez
Pour les artefacts Javadoc, Mintlify regroupe les pages par package. Lorsqu’un package mélange plusieurs genres, il les imbrique sous Interfaces, Classes, Enums, Records, Exceptions, Errors et Annotations, dans l’ordre utilisé par Javadoc sur ses pages de package.
+Pour les artefacts Go, Mintlify regroupe les pages par package. Chaque package commence par une page de présentation qui affiche le `README` et le commentaire de documentation du package, suivie d’un index de ses types et fonctions. Chaque type et chaque fonction au niveau du package dispose de sa propre page. La page d’un type comprend ses champs, ses constructeurs et ses méthodes.
+
Chaque page générée documente une classe, une interface, une fonction, un type ou un autre symbole de l’artefact et renvoie vers les pages générées associées. Si un convertisseur produit des pages qui n’appartiennent à aucun groupe, Mintlify les regroupe sous un groupe `Reference`.
@@ -146,10 +176,12 @@ Créez un `Client` pour appeler l’API.
La forme chaîne suit le modèle `[source] kind name`. Si vous omettez `source`, la page l’hérite de la configuration `sdk` de l’onglet ou du groupe. La forme chaîne hérite toujours de `format` et ne fonctionne donc que sur les pages situées sous un onglet ou un groupe avec `sdk`. Dans tous les autres cas, définissez `sdk` comme un objet avec les champs ci-dessous. Pour les méthodes et propriétés, incluez le nom du parent, par exemple `method Client.getUser`.
+Pour les artefacts Go, ciblez les structs et les autres types définis avec `type`, les interfaces avec `interface`, les champs de struct avec `property` et les pages de présentation de package avec `package`. Désignez un package par son nom, suivi du chemin de son répertoire pour les packages imbriqués, par exemple `package openai` ou `package openai.option`. Ajoutez le package au nom d’un symbole, par exemple `type option.RequestOption`, lorsque plusieurs packages ont un symbole portant ce nom.
+
Si vous omettez `title` ou `description`, Mintlify utilise le titre et la description générés pour le symbole.
- Le type de symbole : `class`, `interface`, `enum`, `function`, `type`, `variable`, `method` ou `property`.
+ Le type de symbole : `package`, `class`, `interface`, `enum`, `function`, `type`, `variable`, `method` ou `property`.
@@ -160,6 +192,10 @@ Si vous omettez `title` ou `description`, Mintlify utilise le titre et la descri
Requis pour les cibles `method` et `property`. La classe, l’interface ou le type englobant.
+
+ Pour les artefacts Go, le package qui contient le symbole, par exemple `openai.option`. Utilisez-le lorsque plusieurs packages ont un symbole portant le même nom.
+
+
Remplace le `format` hérité. Requis lorsque la page ne se trouve pas sous un onglet ou un groupe avec `sdk`. Disponible uniquement dans la forme objet.
@@ -174,7 +210,7 @@ Si vous omettez `title` ou `description`, Mintlify utilise le titre et la descri
Définissez `source` sur une URL HTTPS pour récupérer l’artefact au moment du build au lieu de le committer dans votre dépôt de documentation.
-Les formats à fichier unique (`typedoc`, `phpdoc`) acceptent une URL de fichier directe. Les formats à répertoire (`docfx`, `javadoc`, `sphinx`) acceptent une archive zip. Les jars Javadoc publiés sur Maven Central fonctionnent sans reconditionnement :
+Les formats à fichier unique (`typedoc`, `phpdoc`, `go`) acceptent une URL de fichier directe. Les formats à répertoire (`docfx`, `javadoc`, `sphinx`) acceptent une archive zip. Les jars Javadoc publiés sur Maven Central fonctionnent sans reconditionnement :
```json
{
diff --git a/fr/organize/navigation.mdx b/fr/organize/navigation.mdx
index 5e3ca999c6..72dc93bdb4 100644
--- a/fr/organize/navigation.mdx
+++ b/fr/organize/navigation.mdx
@@ -608,7 +608,7 @@ Pour plus d'informations sur la manière de référencer des endpoints OpenAPI d
## Références SDK
## 生成构建产物
@@ -47,8 +48,35 @@ python -m sphinx -b json docs/source artifacts/json
phpdoc -d src -t artifacts --template=xml
```
+```bash Go
+go run github.com/mintlify/mintlify-go-extractor@latest -o go.json
+```
+
+
+ ### Go
+
+
+Go 自带的文档工具只输出文本和 HTML，不会生成机器可读的构建产物，因此 Mintlify 维护了开源命令 [`mintlify-go-extractor`](https://github.com/mintlify/mintlify-go-extractor) 来生成构建产物。在你的 Go 模块内的任意位置运行它即可。它使用 Go 标准库读取模块的源文件，因此不会下载依赖，也不需要凭据，并且适用于私有模块。
+
+使用 Go 1.24 或更高版本时，可以在模块的 `go.mod` 中固定该提取器，让每次运行都使用同一版本：
+
+```bash
+go get -tool github.com/mintlify/mintlify-go-extractor@latest
+go tool mintlify-go-extractor -o go.json
+```
+
+每个 [release](https://github.com/mintlify/mintlify-go-extractor/releases) 都附带适用于 macOS、Linux 和 Windows 的预编译二进制文件。
+
+默认情况下，提取器会为模块中除 `internal` 包和命令之外的所有包生成文档，并将文档注释按 Markdown 读取，这也是生成式 SDK（例如由 Stainless、Speakeasy 或 Fern 生成的 SDK）所写的格式。常用选项：
+
+- `-comments=godoc`：按 Go 的[文档注释语法](https://go.dev/doc/comment)而不是 Markdown 读取文档注释。
+- `-exclude`：跳过指定的包，格式为以逗号分隔的包模式列表。
+- `-goos`、`-goarch`、`-tags`：选择用于筛选文件的平台和构建标签。默认值为 `linux/amd64`。
+
+传入包模式（例如 `./option/...`）即可只为模块的一部分生成文档。完整选项请参阅[提取器 README](https://github.com/mintlify/mintlify-go-extractor#readme)。
+
## 自动填充 SDK 页面
@@ -94,7 +122,7 @@ phpdoc -d src -t artifacts --template=xml
- 用于生成构建产物的文档工具：`typedoc`、`docfx`、`javadoc`、`sphinx` 或 `phpdoc`。
+ 用于生成构建产物的文档工具：`typedoc`、`docfx`、`javadoc`、`sphinx`、`phpdoc` 或 `go`。
@@ -121,6 +149,8 @@ Mintlify 会将生成的导航组添加到 tab 中已有的任何 `groups` 之
对于 Javadoc 产物，Mintlify 会按包对页面进行分组。当一个包中混合了多种类型时，会按 Javadoc 包页面所用的顺序，将它们嵌套在 Interfaces、Classes、Enums、Records、Exceptions、Errors 和 Annotations 之下。
+对于 Go 产物，Mintlify 会按包对页面进行分组。每个包以一个概览页面开头，展示该包的 `README` 和文档注释，随后是其类型和函数的索引。每个类型和每个包级函数都有各自的页面。类型页面包含其字段、构造函数和方法。
+
每个生成的页面都记录了构建产物中的一个类、接口、函数、类型或其他符号，并链接到相关的生成页面。如果转换器生成的页面不属于任何组，Mintlify 会将它们归入 `Reference` 组。
@@ -146,10 +176,12 @@ sdk: "class Client"
字符串形式遵循 `[source] kind name` 的模式。如果省略 `source`，页面会从 tab 或 group 的 `sdk` 配置继承。字符串形式始终继承 `format`，因此只能用于带有 `sdk` 的 tab 或 group 下的页面。其他情况下，请将 `sdk` 设置为包含下述字段的对象。对于 method 和 property，请包含父级名称，例如 `method Client.getUser`。
+对于 Go 产物，struct 和其他自定义类型使用 `type`，interface 使用 `interface`，struct 字段使用 `property`，包概览页面使用 `package`。引用包时使用包名，嵌套包则在包名后加上其目录路径，例如 `package openai` 或 `package openai.option`。当多个包中有同名符号时，在符号名前加上包名，例如 `type option.RequestOption`。
+
如果省略 `title` 或 `description`，Mintlify 会使用为该符号生成的标题和描述。
- 符号类型：`class`、`interface`、`enum`、`function`、`type`、`variable`、`method` 或 `property`。
+ 符号类型：`package`、`class`、`interface`、`enum`、`function`、`type`、`variable`、`method` 或 `property`。
@@ -160,6 +192,10 @@ sdk: "class Client"
对 `method` 和 `property` 目标为必填。所属的 class、interface 或 type。
+
+ 对于 Go 产物，表示包含该符号的包，例如 `openai.option`。当多个包中有同名符号时使用。
+
+
覆盖继承的 `format`。当页面不属于带有 `sdk` 的 tab 或 group 时为必填。仅在对象形式中可用。
@@ -174,7 +210,7 @@ sdk: "class Client"
将 `source` 设置为 HTTPS URL，即可在构建时获取构建产物，而无需将其提交到文档仓库中。
-单文件格式（`typedoc`、`phpdoc`）可直接接受文件 URL。目录格式（`docfx`、`javadoc`、`sphinx`）接受 `zip` 压缩包。发布到 Maven Central 的 Javadoc jar 无需重新打包即可使用：
+单文件格式（`typedoc`、`phpdoc`、`go`）可直接接受文件 URL。目录格式（`docfx`、`javadoc`、`sphinx`）接受 `zip` 压缩包。发布到 Maven Central 的 Javadoc jar 无需重新打包即可使用：
```json
{
diff --git a/zh/organize/navigation.mdx b/zh/organize/navigation.mdx
index c709d44950..4098ec1891 100644
--- a/zh/organize/navigation.mdx
+++ b/zh/organize/navigation.mdx
@@ -575,7 +575,7 @@ boost: 3
## SDK 参考