Soporte DingDong

Appearance

Preparar Windows para editar documentación ​

Esta guía explica cómo preparar Windows para editar documentación (en VitePress) y poder ejecutarla localmente.

1. Instalar GitHub Desktop (recomendado) ​

GitHub Desktop incluye Git integrado, así que no es necesario instalar Git por separado.

Descargar desde:
https://desktop.github.com

Esto permitirá clonar el repositorio, hacer cambios y subirlos sin usar la terminal.

2. Instalar Node.js (incluye npm) ​

Para poder ejecutar npm run dev, necesitas Node.js. La versión recomendada es la LTS.

Pasos:

  1. Ir a: https://nodejs.org
  2. Descargar Windows Installer (LTS).
  3. Ejecutar el instalador y dejar todas las opciones por defecto.
  4. Comprobar que quedó instalado abriendo PowerShell y escribiendo:
node -v
npm -v

Si ambos comandos devuelven una versión, ya está listo.

3. Abrir el proyecto por primera vez ​

  1. Abrir GitHub Desktop.
  2. En el menú, elegir File → Clone repository.
  3. Seleccionar el repositorio de la documentación.
  4. Una vez clonado, clic en Open in Visual Studio Code (o abrir la carpeta manualmente).

Nota: VS Code no es obligatorio, pero facilita mucho editar archivos Markdown.
Puede descargarse desde: https://code.visualstudio.com

4. Instalar dependencias del proyecto ​

Dentro de la carpeta del proyecto:

  1. Abrir la terminal desde VS Code (o PowerShell).
  2. Ejecutar:
npm install

Esto se hace solo la primera vez.

5. Ejecutar la documentación localmente ​

Para ver la documentación en el navegador mientras la editas:

cd  D:\DingDong\GitDD\dingdong-docs
npm run docs:dev

Normalmente se abre en:

http://localhost:5173

6. Subir los cambios (“Push”) a GitHub ​

Cuando hayas editado algún Markdown:

  1. Abrir GitHub Desktop.
  2. Verás los archivos modificados en la columna izquierda.
  3. Escribir un mensaje breve de lo que cambiaste (por ejemplo: “Actualizo introducción”).
  4. Hacer clic en Commit to main (o al branch que corresponda).
  5. Luego clic en Push origin para subir los cambios.

¡Listo! Los cambios quedan subidos a GitHub y publicados en el sitio de soporte en menos de un minuto..