Skip to content

Translate content: SDK reference setup polish (fr, es, zh) #6742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mintlify merged 1 commit into from
Jul 24, 2026
+60 −24
Merged

Translate content: SDK reference setup polish (fr, es, zh) #6742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions es/api-playground/sdk-reference-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,24 +70,36 @@ Agrega una propiedad `sdk` a una pestaña en tu `docs.json`. Mintlify analiza el
}
```

<ResponseField name="format" type="string" required>
<Note>
Debes declarar `sdk` en una [pestaña](/es/organize/navigation#tabs). Una pestaña con `sdk` puede incluir `groups`, pero no otras estructuras de navegación, como `pages`, `versions` o `languages`. Tampoco puede incluir una propiedad `openapi`, `asyncapi` o `graphql`.
</Note>

<ParamField path="format" type="string" required>
La herramienta de documentación que produjo el artefacto: `typedoc`, `docfx`, `javadoc`, `sphinx` o `phpdoc`.
</ResponseField>
</ParamField>

<ResponseField name="source" type="string" required>
Ruta relativa al archivo o directorio del artefacto en tu repositorio de documentación, o una URL HTTPS.
</ResponseField>
<ParamField path="source" type="string" required>
Ruta relativa al archivo o directorio del artefacto en tu repositorio de documentación, o una URL HTTPS. No admite URLs HTTP.
</ParamField>

<ResponseField name="directory" type="string">
<ParamField path="directory" type="string">
El prefijo de la ruta URL para las páginas generadas. El valor predeterminado es `sdk-reference`.
</ResponseField>
</ParamField>

Agrega varias pestañas para documentar varias bibliotecas. Cada pestaña necesita un `directory` único.
Agrega varias pestañas para documentar varias bibliotecas. Usa un `directory` único para cada biblioteca para evitar colisiones de rutas.

<Tip>
Agrega tu directorio de artefactos a [`.mintignore`](/es/organize/mintignore) para que Mintlify trate los artefactos como entradas de compilación en lugar de publicarlos como activos estáticos.
</Tip>

<div id="generated-pages">
## Páginas generadas
</div>

Mintlify agrega los grupos de navegación generados después de cualquier `groups` en la pestaña. Los grupos varían según el formato y pueden representar módulos, paquetes, espacios de nombres o tipos de símbolos.

Cada página generada documenta una clase, interfaz, función, tipo u otro símbolo del artefacto y enlaza con las páginas generadas relacionadas. Si un convertidor produce páginas que no pertenecen a ningún grupo, Mintlify las recopila en un grupo `Reference`.

<div id="use-remote-sources">
## Usar fuentes remotas
</div>
Expand Down
28 changes: 20 additions & 8 deletions fr/api-playground/sdk-reference-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,24 +70,36 @@ Ajoutez une propriété `sdk` à un onglet dans votre `docs.json`. Mintlify anal
}
```

<ResponseField name="format" type="string" required>
<Note>
Vous devez déclarer `sdk` sur un [onglet](/fr/organize/navigation#tabs). Un onglet avec `sdk` peut inclure `groups`, mais aucune autre structure de navigation, telle que `pages`, `versions` ou `languages`. Il ne peut pas non plus inclure une propriété `openapi`, `asyncapi` ou `graphql`.
</Note>

<ParamField path="format" type="string" required>
L’outil de documentation qui a produit l’artefact : `typedoc`, `docfx`, `javadoc`, `sphinx` ou `phpdoc`.
</ResponseField>
</ParamField>

<ResponseField name="source" type="string" required>
Chemin relatif vers le fichier ou le répertoire de l’artefact dans votre dépôt de documentation, ou une URL HTTPS.
</ResponseField>
<ParamField path="source" type="string" required>
Chemin relatif vers le fichier ou le répertoire de l’artefact dans votre dépôt de documentation, ou une URL HTTPS. N’accepte pas les URL HTTP.
</ParamField>

<ResponseField name="directory" type="string">
<ParamField path="directory" type="string">
Le préfixe de chemin d’URL pour les pages générées. Par défaut, `sdk-reference`.
</ResponseField>
</ParamField>

Ajoutez plusieurs onglets pour documenter plusieurs bibliothèques. Chaque onglet doit avoir un `directory` unique.
Ajoutez plusieurs onglets pour documenter plusieurs bibliothèques. Utilisez un `directory` unique pour chaque bibliothèque afin d’éviter les collisions de routes.

<Tip>
Ajoutez le répertoire de votre artefact à [`.mintignore`](/fr/organize/mintignore) afin que Mintlify traite les artefacts comme des entrées de build plutôt que de les publier comme des ressources statiques.
</Tip>

<div id="generated-pages">
## Pages générées
</div>

Mintlify ajoute les groupes de navigation générés après les éventuels `groups` de l’onglet. Les groupes varient selon le format et peuvent représenter des modules, des packages, des espaces de noms ou des types de symboles.

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`.

<div id="use-remote-sources">
## Utiliser des sources distantes
</div>
Expand Down
28 changes: 20 additions & 8 deletions zh/api-playground/sdk-reference-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,24 +70,36 @@ phpdoc -d src -t artifacts --template=xml
}
```

<ResponseField name="format" type="string" required>
<Note>
你必须在 [tab](/zh/organize/navigation#tabs) 上声明 `sdk`。包含 `sdk` 的 tab 可以包含 `groups`，但不能包含其他导航结构，例如 `pages`、`versions` 或 `languages`。它也不能包含 `openapi`、`asyncapi` 或 `graphql` 属性。
</Note>

<ParamField path="format" type="string" required>
生成构建产物的文档工具：`typedoc`、`docfx`、`javadoc`、`sphinx` 或 `phpdoc`。
</ResponseField>
</ParamField>

<ResponseField name="source" type="string" required>
指向文档仓库中构建产物文件或目录的相对路径，或者一个 HTTPS URL。
</ResponseField>
<ParamField path="source" type="string" required>
指向文档仓库中构建产物文件或目录的相对路径，或者一个 HTTPS URL。不接受 HTTP URL。
</ParamField>

<ResponseField name="directory" type="string">
<ParamField path="directory" type="string">
生成页面的 URL 路径前缀。默认值为 `sdk-reference`。
</ResponseField>
</ParamField>

添加多个 tab 即可为多个库生成文档。每个 tab 都需要一个唯一的 `directory`。
添加多个 tab 即可为多个库生成文档。为每个库使用唯一的 `directory`，以避免路由冲突。

<Tip>
将你的构建产物目录添加到 [`.mintignore`](/zh/organize/mintignore)，让 Mintlify 将这些产物视为构建输入，而不是作为静态资源发布。
</Tip>

<div id="generated-pages">
## 生成的页面
</div>

Mintlify 会将生成的导航组添加到 tab 上任何 `groups` 之后。这些组因格式而异，可能表示模块、包、命名空间或符号类型。

每个生成的页面都记录了构建产物中的一个类、接口、函数、类型或其他符号，并链接到相关的生成页面。如果转换器生成的页面不属于任何组，Mintlify 会将它们归入 `Reference` 组。

<div id="use-remote-sources">
## 使用远程源
</div>
Expand Down