📄Documentación

Ayude a ampliar la documentación de GaiaNet, facilitando los primeros pasos a los nuevos desarrolladores, ¡así es como puede empezar!

Contribución

  1. Fork el repositorio:

    • Haga clic en el botón "Fork" de la esquina superior derecha

    • Seleccione dónde desea bifurcar el repositorio (su cuenta personal o una organización)

  2. Clone su repositorio:

    git clone https://github.com/YOUR-USERNAME/docs.git
    cd docs
  3. Crea una nueva rama para tus cambios:

    git checkout -b tu-rama-característica
  4. Realice sus cambios en la documentación

  5. Confirme los cambios:

    git add . 
    git commit -m "Descripción de tus cambios"
  6. Empuje sus cambios a su tenedor:

    git push origin tu-característica-branch
  7. Crear un pull request:

    • Vaya a su bifurcación en GitHub

    • Haga clic en "Pull request" y seleccione "New pull request".

    • Seleccione su rama y envíe el pull request Asegúrese de que sus contribuciones se ajustan al estilo y las normas de nuestra documentación.

Ejecución local de la documentación

Después de bifurcar y clonar el repositorio:

  1. Instalar dependencias:

    npm instalar
  2. Inicie el servidor de desarrollo:

    npm iniciar
  3. Abra su navegador y visite http://localhost:3000

Estructura

  • docs/: Contiene todos los archivos markdown para la documentación

  • src/: Componentes y páginas React personalizados

  • estático/: Activos estáticos como imágenes

  • docusaurus.config.js: Archivo principal de configuración de Docusaurus

Despliegue

Esta documentación se despliega automáticamente en docs.gaianet.ai cuando los cambios se fusionan en la rama principal.

¿Necesita ayuda?

Si tiene alguna pregunta o necesita ayuda, abra una incidencia en el repositorio o póngase en contacto con nosotros a través de nuestros canales de la comunidad.

Última actualización

¿Te ha resultado útil?