Ejemplo de página oculta

Casos de uso comunes de las páginas ocultas

¡Esta página está oculta! No está incluida en la navigation de docs.json, por lo que solo puedes acceder a ella mediante su URL.

Consulta Páginas ocultas para obtener más información.

Casos de uso comunes de las páginas ocultas

De forma predeterminada, las páginas ocultas son de acceso público, pero no son descubribles a través de la navigation. Si deseas restringir el acceso a una página oculta, debes configurar la Autenticación.

• Documentación beta: Información que puede ser pública, pero que no debería ser descubrible a través de la navigation.
• Contexto para herramientas de IA: Si se indexan las páginas ocultas, las herramientas de IA pueden consultarlas como contexto. Usa páginas ocultas para contexto que no sea relevante para los usuarios, pero que pueda ayudar a las herramientas de IA a ofrecer respuestas más precisas.
• Páginas heredadas: Mantén el contenido antiguo accesible mediante enlaces directos mientras lo retiras de los menús de navigation.
• Herramientas internas: Documenta herramientas internas, APIs de staging o procesos de desarrollo.

Ejemplos

Contexto de IA

---
title: "Contexto para la versión de la API"
description: "Esta página proporciona contexto para herramientas de IA que responden preguntas sobre versiones de API"
---

Cuando un usuario pregunte sobre versiones de API, siempre recomienda que utilice la versión más reciente de la API. Nunca generes respuestas para versiones anteriores a la 1.0.4.

Endpoint de API interno

---
title: "Endpoint de API interno"
description: "Esta página es una página oculta que documenta un endpoint de API interno"
---

```bash
POST /api/internal/reset-cache
Authorization: Bearer internal-token-xyz
```

Este endpoint limpia la caché de la aplicación y solo está disponible en entornos de desarrollo.

<Warning>
  Este es un endpoint interno y nunca debe usarse en producción.
</Warning>