Jamdesk Documentation logo

Recorrido de incorporación

Completa la incorporación guiada para configurar tu primer sitio: crea un proyecto, conecta GitHub, configura docs.json e inicia tu primer build.

Los 5 pasos

1
Iniciar prueba

Cuando inicias sesión por primera vez, Jamdesk activa automáticamente tu prueba gratuita de 14 días del plan Pro.

  • Acceso completo a todas las funciones
  • La prueba termina 14 días después de la activación
2
Crear proyecto

Ponle un nombre a tu proyecto de documentación:

  • Usa un nombre claro y descriptivo (por ejemplo, "API Documentation", "User Guide")
  • Este pasa a formar parte de la URL de tu sitio de documentación
  • Puedes cambiar el nombre visible más adelante en la configuración del proyecto
3
Conectar GitHub y crear docs iniciales

Jamdesk crea un nuevo repositorio de GitHub a partir de la plantilla inicial:

  • Páginas de ejemplo con contenido y componentes realistas
  • docs.json preconfigurado con navegación e identidad de marca
  • Ejemplo de spec de OpenAPI para páginas de referencia de la API
  • Listo para editar y hacer push de inmediato
4
Instalar la CLI

La CLI de Jamdesk permite el desarrollo local:

npm install -g jamdesk

Puedes omitir este paso durante la incorporación e instalar la CLI en cualquier momento. Si lo omites, igualmente puedes editar la documentación directamente en GitHub.

5
Empezar a editar

¡Ya estás listo para hacer build! Edita tu documentación:

  • Por CLI: edita archivos localmente con jamdesk dev
  • Por GitHub: edita archivos .mdx directamente en tu repositorio
  • En Jamdesk: algunas funciones del dashboard están disponibles (según el plan)

Los cambios activan automáticamente rebuilds de la documentación cuando haces push a GitHub.

Después de la incorporación

Una vez que completes la incorporación, puedes:

Solución de problemas

Omití un paso, ¿puedo volver atrás?

Puedes completar la incorporación en cualquier momento desde el dashboard de tu proyecto. Busca la tarjeta de incorporación para continuar donde lo dejaste.

Elegí el repositorio de GitHub incorrecto

Crea un nuevo proyecto con el repositorio correcto. Puedes eliminar el anterior cuando quieras.

Necesito ayuda durante la incorporación

Contacta a soporte en cualquier momento del proceso.

Artículos relacionados

Primer build

Inicia y verifica tu primer build

Recorrido del dashboard

Aprende a usar el dashboard de Jamdesk