Skip to content

ctrlnode-ai/mintlify-starter

Repository files navigation

CtrlNode — documentación (Mintlify)

Sitio de documentación del producto (web app + Bridge). El código de la app está en el monorepo padre (src/CtrlNode.Web, etc.); esta carpeta solo contiene los .mdx y docs.json.

Requisitos

  • Node.js 18+ (LTS recomendado)
  • Terminal (PowerShell en Windows)

No hace falta npm install en esta carpeta: el CLI se ejecuta con npx o instalación global.

Ver la doc en local (localhost)

Abre PowerShell en esta carpeta (donde está docs.json):

cd C:\CODE\2026\CtrlNode\mintlify-starter

Opción recomendada — sin instalar nada global

npx mint dev

La primera vez puede tardar 1–2 minutos (descarga el CLI de Mintlify).

Opción alternativa — CLI global

npm install -g mint
mint dev

Abrir en el navegador

http://localhost:3000

Deberías ver las pestañas Documentation y Bridge, y en el menú la página Files (/getting-started/files).

Para parar el servidor: Ctrl+C en la misma terminal.

Comandos útiles

Comando Para qué
npx mint dev Servidor local con recarga al guardar .mdx
npx mint broken-links Comprobar enlaces rotos
npx mint update Actualizar el CLI si falla algo raro

Estructura rápida

Ruta Contenido
docs.json Navegación, tabs, redirects
getting-started/ Tour de la app (Projects, Tasks, Files, Bridge setup…)
projects/ Work directory del proyecto
tasks/ Crear tarea, modos OUTPUT ONLY / WORK DIRECTORY
bridge/ Instalar ctrlnode, configuración, providers (Hermes, etc.)
workflows/, routines/, events/ Resto de la doc

Convenciones de nombres (app vs doc): ver AGENTS.md en esta carpeta.

Publicar cambios

  1. Edita los .mdx y prueba con npx mint dev.
  2. Commit en tu rama (p. ej. doc-2705).
  3. Abre PR a main en el repositorio de documentación conectado a Mintlify.
  4. Tras el merge, Mintlify despliega solo (no hace falta MCP ni subida manual).

Problemas frecuentes

mint no se reconoce
Usa npx mint dev en lugar de mint dev.

404 al abrir una página
Ejecuta el comando desde mintlify-starter, no desde la raíz del monorepo CtrlNode.

Puerto 3000 ocupado
Cierra otra instancia de mint dev o mira en la salida de la terminal si Mintlify usa otro puerto.

Imágenes que no cargan en local
Muchas vienen de GitHub raw (docs/product-screenshots/…); hace falta red. Si fallan, en producción suelen verse igual si el branch de imágenes existe en GitHub.

Enlaces

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages