Ocultar o mostrar docs
Cómo una empresa oculta esta documentación o sus enlaces.
En esta página
Cada empresa decide si su instancia muestra esta documentación y dónde se enlaza. Se configura en theme.landing.docs del dominio (ver Landing y login) y se aplica sin desplegar: el frontend lee la configuración desde GET /api/config.
Opciones#
| Campo | Por defecto | Efecto |
|---|---|---|
docs.visible | true | Si es false, las páginas /docs no se muestran: aparece una página 404 amable ("DocsHidden") sin enlaces a /docs, y todos los enlaces siguientes se ocultan |
docs.landingLink | true | Enlace "Documentación" en el hero/cabecera de login y registro |
docs.showInFooter | false (opt-in) | Enlace "Documentación" en el pie de la landing |
docs.showInSidebar | true | Reservado para la barra lateral/ajustes de la app. Hoy ninguna pantalla lo consume: la opción se calcula y se valida, pero no muestra ni oculta nada |
Sin configuración se conserva el comportamiento histórico: documentación abierta y enlace en el login.
Ejemplos#
{
"landing": {
"docs": { "visible": false }
}
}{
"landing": {
"docs": { "visible": true, "landingLink": false, "showInFooter": true }
}
}Estos objetos van dentro de theme (junto al resto de la configuración). Recuerda que PUT /api/admin/domain reemplaza el tema completo: envía también colores y demás campos, o los perderás.
Cómo funciona#
- El layout de
/docsleelanding.docsconuseLandingConfig()(que re-sanea la configuración en el cliente) yresolveDocsVisibility(). - Mientras la configuración carga,
/docsno pinta contenido, para evitar un parpadeo de documentación que luego se oculta. - Si
visibleesfalse, se muestraDocsHidden(404 amigable con un botón hacia el login), en el idioma de la landing. - Los enlaces del hero (
landingLink) y del pie (footer) se calculan con la misma función, así que siempre son coherentes convisible.
Ocultar no es proteger
La ocultación es de interfaz: /docs sigue respondiendo 200 y el contenido de la documentación viaja en el JavaScript de la aplicación. Además /docs es una ruta pública en el middleware. Si necesitas que la documentación no sea accesible, no la despliegues en esa instancia (por ejemplo, elimina src/app/docs). En esta documentación no hay secretos ni datos de tu instancia.
Dónde se cambia#
- Por API:
PUT /api/admin/domaincon elthemecompleto (sesión de manager del dominio). - Por el editor de landing del panel de administración, cuando esté disponible en tu versión (sección "Documentación": *documentación visible*, *enlace en el pie*, …).