-
Notifications
You must be signed in to change notification settings - Fork 238
Update from code changes: document related pages add-on #6510
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.
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
Open
mintlify
wants to merge
6
commits into
main
Choose a base branch
from
mintlify/0dbda2de
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0c239a7
docs: add related pages configuration and frontmatter
mintlify[bot] bfc1ddd
docs: translate related pages content to es, fr, zh
mintlify[bot] e8955a3
Apply suggestion from @ethanpalm
ethanpalm d3eb58d
Apply suggestion from @ethanpalm
ethanpalm 0a0f85c
Apply suggestions from code review
ethanpalm 7d6846e
Apply suggestions from code review
ethanpalm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| --- | ||
| title: "Páginas relacionadas" | ||
| description: "Muestra una sección de Temas relacionados en la parte inferior de cada página con sugerencias automáticas basadas en búsqueda o enlaces seleccionados manualmente desde el frontmatter." | ||
| keywords: ["relacionadas", "páginas relacionadas", "temas relacionados", "recomendaciones", "frontmatter"] | ||
| --- | ||
|
|
||
| Las páginas relacionadas muestran una sección de **Temas relacionados** en la parte inferior de cada página de documentación, ayudando a los lectores a descubrir contenido conectado. Las sugerencias pueden provenir de recomendaciones basadas en búsqueda, de enlaces que seleccionas en el frontmatter de la página o de una combinación de ambos. | ||
|
|
||
| <div id="enable-related-pages"> | ||
| ## Habilitar páginas relacionadas | ||
| </div> | ||
|
|
||
| Las páginas relacionadas son un add-on de la implementación. Habilítalo en tu panel: | ||
|
|
||
| 1. Abre tu panel y ve a **Configuración** > **Add-ons**. | ||
| 2. Encuentra **Temas relacionados** y actívalo. | ||
| 3. Elige un modo y, opcionalmente, establece un límite en cuántas páginas se muestran. | ||
|
|
||
| <div id="modes"> | ||
| ## Modos | ||
| </div> | ||
|
|
||
| <ResponseField name="Automatic" type="mode"> | ||
| Las sugerencias se generan a partir del índice de búsqueda de tus documentos usando el título de la página actual. Las anulaciones en el frontmatter siguen teniendo prioridad cuando se configuran. Usa este modo cuando quieras que las páginas relacionadas se actualicen automáticamente a medida que agregas contenido. | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="Manual" type="mode"> | ||
| Solo se muestran las páginas listadas en el frontmatter `related` de una página. Las páginas sin un campo `related` no muestran ninguna sección de **Temas relacionados**. Usa este modo cuando quieras control editorial total. | ||
| </ResponseField> | ||
|
|
||
| <div id="limit"> | ||
| ### Límite | ||
| </div> | ||
|
|
||
| Establece cuántas páginas relacionadas mostrar. El valor predeterminado es `5` y el máximo es `10`. El límite se aplica a las sugerencias automáticas; las entradas manuales están limitadas al máximo. | ||
|
|
||
| <div id="configure-per-page-with-frontmatter"> | ||
| ## Configurar por página con frontmatter | ||
| </div> | ||
|
|
||
| Usa el campo de frontmatter `related` para anular o proporcionar la lista de páginas relacionadas para una sola página. Esto funciona tanto en el modo **Automático** como en el **Manual**. | ||
|
|
||
| <ResponseField name="related" type="array | false"> | ||
| Una lista de páginas relacionadas, o `false` para ocultar la sección **Temas relacionados** en esta página. | ||
|
|
||
| Cada entrada puede ser: | ||
| - Una ruta relativa a la raíz de otra página en tus documentos: `/api-playground/overview` | ||
| - Una URL absoluta a un sitio externo: `https://example.com/docs` | ||
| - Un objeto `Title: link` para establecer una etiqueta explícita | ||
|
|
||
| Los títulos e íconos para las rutas internas se infieren de tu navegación cuando no se establecen explícitamente. Los enlaces externos se abren en una nueva pestaña. | ||
| </ResponseField> | ||
|
|
||
| <div id="examples"> | ||
| ### Ejemplos | ||
| </div> | ||
|
|
||
| Selecciona una lista de páginas internas: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Authentication" | ||
| related: | ||
| - /api-playground/overview | ||
| - /deploy/authentication-setup | ||
| - /organize/hidden-pages | ||
| --- | ||
| ``` | ||
|
|
||
| Combina páginas internas, enlaces externos y títulos personalizados: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Authentication" | ||
| related: | ||
| - Overview: /api-playground/overview | ||
| - Set up auth: /deploy/authentication-setup | ||
| - OAuth 2.0 spec: https://oauth.net/2/ | ||
| --- | ||
| ``` | ||
|
|
||
| Oculta la sección **Temas relacionados** en una página específica: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Changelog" | ||
| related: false | ||
| --- | ||
| ``` | ||
|
|
||
| <div id="how-suggestions-are-generated"> | ||
| ## Cómo se generan las sugerencias | ||
| </div> | ||
|
|
||
| En el modo **Automático**, las páginas relacionadas se generan a partir del índice de búsqueda de tus documentos usando el título de la página actual como consulta. Los resultados se filtran por el idioma y la versión de la página cuando corresponde, y la página actual se excluye. | ||
|
|
||
| Para las implementaciones con [autenticación de usuario final](/es/deploy/authentication-setup), las sugerencias automáticas están deshabilitadas para evitar filtrar contenido entre contextos de usuario. Usa el campo de frontmatter `related` para mostrar sugerencias seleccionadas en implementaciones autenticadas por usuario. | ||
|
|
||
| <div id="related-resources"> | ||
| ## Recursos relacionados | ||
| </div> | ||
|
|
||
| - [Páginas](/es/organize/pages): Configura los metadatos de la página con frontmatter. | ||
| - [Enlaces](/es/guides/linking): Mejores prácticas para conectar páginas entre sí. | ||
| - [Búsqueda](/es/optimize/search): Configura cómo se clasifican y filtran los resultados de búsqueda. |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| --- | ||
| title: "Pages associées" | ||
| description: "Affichez une section Sujets associés en bas de chaque page avec des suggestions automatiques basées sur la recherche ou des liens sélectionnés manuellement depuis le frontmatter." | ||
| keywords: ["associées", "pages associées", "sujets associés", "recommandations", "frontmatter"] | ||
| --- | ||
|
|
||
| Les pages associées font apparaître une section **Sujets associés** en bas de chaque page de documentation, aidant les lecteurs à découvrir du contenu connexe. Les suggestions peuvent provenir de recommandations basées sur la recherche, de liens que vous sélectionnez dans le frontmatter de la page, ou d'un mélange des deux. | ||
|
|
||
| <div id="enable-related-pages"> | ||
| ## Activer les pages associées | ||
| </div> | ||
|
|
||
| Les pages associées sont un module complémentaire de déploiement. Activez-le dans votre tableau de bord : | ||
|
|
||
| 1. Ouvrez votre tableau de bord et accédez à **Paramètres** > **Modules complémentaires**. | ||
| 2. Trouvez **Sujets associés** et activez l'option. | ||
| 3. Choisissez un mode et, éventuellement, définissez une limite du nombre de pages affichées. | ||
|
|
||
| <div id="modes"> | ||
| ## Modes | ||
| </div> | ||
|
|
||
| <ResponseField name="Automatic" type="mode"> | ||
| Les suggestions sont générées à partir de l'index de recherche de votre documentation en utilisant le titre de la page en cours. Les remplacements via le frontmatter restent prioritaires lorsqu'ils sont définis. Utilisez ce mode lorsque vous souhaitez que les pages associées se mettent à jour automatiquement à mesure que vous ajoutez du contenu. | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="Manual" type="mode"> | ||
| Seules les pages listées dans le champ `related` du frontmatter d'une page sont affichées. Les pages sans champ `related` n'affichent aucune section **Sujets associés**. Utilisez ce mode lorsque vous souhaitez un contrôle éditorial complet. | ||
| </ResponseField> | ||
|
|
||
| <div id="limit"> | ||
| ### Limite | ||
| </div> | ||
|
|
||
| Définissez le nombre de pages associées à afficher. La valeur par défaut est `5` et la valeur maximale est `10`. La limite s'applique aux suggestions automatiques ; les entrées manuelles sont plafonnées à la valeur maximale. | ||
|
|
||
| <div id="configure-per-page-with-frontmatter"> | ||
| ## Configurer par page avec le frontmatter | ||
| </div> | ||
|
|
||
| Utilisez le champ de frontmatter `related` pour remplacer ou fournir la liste des pages associées pour une seule page. Cela fonctionne à la fois en mode **Automatic** et en mode **Manual**. | ||
|
|
||
| <ResponseField name="related" type="array | false"> | ||
| Une liste de pages associées, ou `false` pour masquer la section **Sujets associés** sur cette page. | ||
|
|
||
| Chaque entrée peut être : | ||
| - Un chemin relatif à la racine vers une autre page de votre documentation : `/api-playground/overview` | ||
| - Une URL absolue vers un site externe : `https://example.com/docs` | ||
| - Un objet `Title: link` pour définir un libellé explicite | ||
|
|
||
| Les titres et icônes des chemins internes sont déduits de votre navigation lorsqu'ils ne sont pas définis explicitement. Les liens externes s'ouvrent dans un nouvel onglet. | ||
| </ResponseField> | ||
|
|
||
| <div id="examples"> | ||
| ### Exemples | ||
| </div> | ||
|
|
||
| Sélectionnez une liste de pages internes : | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Authentication" | ||
| related: | ||
| - /api-playground/overview | ||
| - /deploy/authentication-setup | ||
| - /organize/hidden-pages | ||
| --- | ||
| ``` | ||
|
|
||
| Mélangez pages internes, liens externes et titres personnalisés : | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Authentication" | ||
| related: | ||
| - Overview: /api-playground/overview | ||
| - Set up auth: /deploy/authentication-setup | ||
| - OAuth 2.0 spec: https://oauth.net/2/ | ||
| --- | ||
| ``` | ||
|
|
||
| Masquez la section **Sujets associés** sur une page spécifique : | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Changelog" | ||
| related: false | ||
| --- | ||
| ``` | ||
|
|
||
| <div id="how-suggestions-are-generated"> | ||
| ## Comment les suggestions sont générées | ||
| </div> | ||
|
|
||
| En mode **Automatic**, les pages associées sont générées à partir de l'index de recherche de votre documentation en utilisant le titre de la page en cours comme requête. Les résultats sont filtrés selon la langue et la version de la page, le cas échéant, et la page en cours est exclue. | ||
|
|
||
| Pour les déploiements avec [authentification des utilisateurs finaux](/fr/deploy/authentication-setup), les suggestions automatiques sont désactivées afin d'éviter les fuites de contenu entre contextes utilisateur. Utilisez le champ de frontmatter `related` pour afficher des suggestions sélectionnées sur les déploiements avec authentification utilisateur. | ||
|
|
||
| <div id="related-resources"> | ||
| ## Ressources associées | ||
| </div> | ||
|
|
||
| - [Pages](/fr/organize/pages) : Configurez les métadonnées de page avec le frontmatter. | ||
| - [Création de liens](/fr/guides/linking) : Bonnes pratiques pour relier les pages entre elles. | ||
| - [Recherche](/fr/optimize/search) : Configurez la façon dont les résultats de recherche sont classés et filtrés. |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| title: "Related topics" | ||
| description: "Add links to related pages at the bottom of each page with automatic suggestions or manually curated links from frontmatter." | ||
| keywords: ["related", "related pages", "related topics", "recommendations", "frontmatter"] | ||
| --- | ||
|
|
||
| Add related topics to the bottom of each page to help readers discover relevant content. Suggested pages can come from automated recommendations, from links you curate in page frontmatter, or from a mix of both. | ||
|
|
||
| ## Enable related topics | ||
|
|
||
| 1. Navigate to the [Add-ons](https://app.mintlify.com/settings/deployment/addons) page in your dashboard. | ||
| 2. In the "Related topics" section, enable **Show related topics**. | ||
| 3. Choose a mode and, optionally, set a limit on how many pages are shown. | ||
|
|
||
| ## Modes | ||
|
|
||
| <ResponseField name="Automatic" type="mode"> | ||
| Mintlify generates suggestions from your contents' search index using the current page's title. Frontmatter overrides still take precedence over automatic suggestions. Use this mode when you want related pages to update automatically as you add content. | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="Manual" type="mode"> | ||
| Only pages listed in a page's `related` frontmatter are shown. Pages without a `related` field display no **Related topics** section. Use this mode when you want full editorial control. | ||
| </ResponseField> | ||
|
|
||
| ### Limit | ||
|
|
||
| Set how many related pages to display. The default is `5` and the maximum is `10`. | ||
|
|
||
| ## Configure per page with frontmatter | ||
|
|
||
| Use the `related` frontmatter field to override or supply the list of related pages for a single page. This works in both **Automatic** and **Manual** modes. | ||
|
|
||
| <ResponseField name="related" type="array | false"> | ||
| A list of related pages, or `false` to hide the **Related topics** section on this page. | ||
|
|
||
| Each entry can be: | ||
| - A root-relative path to another page in your docs: `/api-playground/overview` | ||
| - An absolute URL to an external site: `https://example.com/docs` | ||
| - A `Title: link` object to set an explicit label | ||
|
|
||
| If you don't explicitly set titles and icons for internal paths, Mintlify infers them. External links open in a new tab. | ||
| </ResponseField> | ||
|
|
||
| ### Examples | ||
|
|
||
| Curate a list of internal pages: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Authentication" | ||
| related: | ||
| - /api-playground/overview | ||
| - /deploy/authentication-setup | ||
| - /organize/hidden-pages | ||
| --- | ||
| ``` | ||
|
|
||
| Mix internal pages, external links, and custom titles: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Authentication" | ||
| related: | ||
| - Overview: /api-playground/overview | ||
| - Set up auth: /deploy/authentication-setup | ||
| - OAuth 2.0 spec: https://oauth.net/2/ | ||
| --- | ||
| ``` | ||
|
|
||
| Hide the **Related topics** section on a specific page: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Changelog" | ||
| related: false | ||
| --- | ||
| ``` | ||
|
|
||
| ## How suggestions are generated | ||
|
|
||
| In **Automatic** mode, related pages are generated from your docs' search index using the current page's title as the query. Results are filtered by the page's language and version when applicable, and the current page is excluded. | ||
|
Check warning on line 81 in organize/related-pages.mdx
|
||
|
|
||
| For deployments with [end-user authentication](/deploy/authentication-setup), automatic suggestions are disabled to avoid leaking content across user contexts. Use the `related` frontmatter field to show curated suggestions on user-authenticated deployments. | ||
|
|
||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.