Puntos de mejora en la documentación - Githubissues

LinuxCabal / admin-cfdi

Administrador de CFDIs / Proyecto de colaboración con PythonCabal

https://facturalibre.net/servicios/

34 stars 39 forks source link

Puntos de mejora en la documentación #83

Open ppaez opened 8 years ago

ppaez commented 8 years ago

Aquí van algunas ideas para hacer la documentación más útil, a ver qué les parecen:

[ ] Agregar contenido a la introducción, es lo primero que se ve y puede funcionar como carta de presentación
[x] Dar de alta la rama develop en http://readthedocs.org/ para que la documentación se genere y cualquiera pueda verla sin necesidad de instalar el proyecto
[x] Dar de alta la rama master en read the docs.
[ ] Includir al final del capítulo Instalación instrucciones para el sistema operativo de las ventanas
[ ] Mover lo que está en el wiki en Cómo colaborar en este proyecto a una sección en la documentación. Mejor que esté junto con el resto si va a ser visible en read the docs.
[ ] En Uso -> admin-cfdi agregar una sección que explique cada función: descargar, descargar de correos, organizar, generar PDF, validar. Qué se puede hacer y las opciones; podemos tomar de lo que ya han preguntado los usuarios antes aquí.

Si tienen más sugerencias, podemos comentarlas aquí y agregarlas para que nos acordemos, e ir palomeando según se vayan realizando.

ghost commented 8 years ago

+10

Me encargo del punto dos

ghost commented 8 years ago

Ahora si, se ve muy lindo: http://admin-cfdi.readthedocs.org/es/develop/

ghost commented 8 years ago

Pense que podiamos asignarnos los dos la tarea, pero veo que no, solo acepta uno

ppaez commented 8 years ago

Ni modo si solo permite asignar una persona :| Sí se ve muy padre en read the docs! A ver si te deja palomear el punto dos arriba, hice clic directamente en la cajita y me dejó.

ghost commented 8 years ago

Si, eso si me dejo... si, se ve muy bien la documentación... gracias por toda tu ayuda...

ppaez commented 8 years ago

Hay un par de temas nuevos en la lista, igual si alguien tiene más ideas, las podemos compartir aquí.

ghost commented 8 years ago

Listo, ahora también tenemos master: http://admin-cfdi.readthedocs.org/es/master/

ghost commented 8 years ago

He creado un video de instalación en Windows 10: https://vimeo.com/155583952

ppaez commented 8 years ago

Está muy bien el video, podemos agregar una liga al mismo en la sección de instalación de la documentación.

ghost commented 8 years ago

Si, lo tengo contemplado mi amigo... saludos...