Bienvenido a Documentación de Repositorios, la herramienta definitiva para generar documentación precisa y completa para tus proyectos de código. Simplifica el acceso y la comprensión de tus repositorios con nuestra solución automatizada.
- Generación Automática: Transforma tus repositorios de código en documentación clara y accesible en minutos.
- Integración con GitHub: Sincroniza fácilmente tus repositorios de GitHub para obtener documentación actualizada.
- Personalización: Personaliza la apariencia y el contenido de la documentación generada para que se ajuste a tus necesidades.
- Colaboración: Facilita la colaboración entre equipos con documentación precisa y fácil de seguir.
- Node.js 18 o superior
- Una cuenta de GitHub
Sigue estos pasos para instalar y configurar la herramienta en tu entorno local:
1 .env enviroment :
OPENAI_API_KEY=""
API_KEY_GEMINIC=""
- Clona este repositorio:
git clone https://github.com/joseandrescolmenares/create-documentation.git npm install npm run dev
¡Las contribuciones son bienvenidas! Si deseas colaborar, por favor sigue estos pasos:
1. Haz un fork de este repositorio.
2. Crea una rama nueva:
git checkout -b mi-nueva-funcionalidad
Realiza tus cambios y haz commits descriptivos.
Envía tus cambios:
git push origin mi-nueva-funcionalidad
Abre un Pull Request en este repositorio.