Documentación dentro de la app
Chinaski lleva su documentación dentro del área de administración: Docs lista artículos integrados más artículos que tú mismo escribes, todo solo para admins. Esta página cubre ambos.
Los artículos integrados
Diez artículos incluidos vienen con la aplicación, cada uno cubre un subsistema importante (el índice de esta página vive en Admin → Docs):
- Blocks: creación y gestión de bloques de contenido reutilizables; tipos, formato de template, incrustación.
- Theme Authoring : la referencia completa de Template Toolkit para templates de site y de bloques, con las reglas de seguridad y la referencia completa de variables.
- LLM Theme Prompting : guía para producir temas ambiciosos y visualmente distintos con asistentes de IA: design briefs, especificaciones de tokens, ciclos de crítica, y plantillas de prompt listas para copiar y pegar.
- Pages & Posts: creación, edición, publicación, programación, categorías, revisiones.
- Navigation : construir menús, ordenamiento, enlaces externos, navegación por idioma.
- Backups: creación/restauración de backups, la programación, el formato de archivo.
- Settings : nombre del site, idiomas, valores SEO por defecto, IDs de analítica, el aviso de cookies, configuración de URL.
- Media Library: subida, organización, referencia de URLs de medios.
- MCP Server : el servidor de Model Context Protocol para gestión asistida por IA.
- API Reference: la referencia completa de
/api/*(autenticación, paginación, cuerpos de petición, esquemas de respuesta).
La documentación interna va más a fondo que el sitio público de documentación : por ejemplo, el artículo Theme Authoring lleva la tabla completa de variables de stash por tipo de template.
Escribir tus propios artículos
Junto a los integrados existe un conjunto editable para docs personalizados: tus páginas de runbook para editores, guías de estilo internas, notas de migración para un cliente : y es completamente data dentro del repositorio:
- New article: se requiere un título; el slug viene de tu entrada o se autogenera desde el título (minúsculas, separado por guiones); los caracteres de slug inválidos se eliminan.
- Sort order : controla la posición de lectura en el índice de docs (el orden desempata por orden de creación).
- Body: texto de cuerpo arbitrario editable por artículo; se guarda en la base de datos (con los backups de tu instancia, como todo lo demás).
El índice lista tus docs personalizados debajo de los integrados, ordenados según tus sort orders. Todo lo que escribas es data local de la instancia : nada se sincroniza ni se publica públicamente; escribe runbooks como documentación interna para tu equipo.
Los docs son territorio de admins
Como algunos artículos cubren operaciones privilegiadas (interiores de temas, API keys, estructura de backups), cada ruta de docs incluidos borradores está protegida por gate de admin: los editores sin rol de admin nunca ven esta sección.