Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- El lenguaje Julia
- Escritor técnico:
- Shuo Liu
- Nombre del proyecto:
- Documentos de LightGraphs 2.0 y instructivos de JuliaGraphs fáciles de usar
- Duración del proyecto:
- Larga duración (5 meses)
Project description
En este proyecto de larga duración, mejoraré el sitio web y la documentación de los módulos en JuliaGraphs. Específicamente, mi trabajo incluirá, entre otros, los siguientes contenidos.
Documentos de LightGraphs 2.0: 10 semanas
- Descripción general: LightGraphs.jl es un paquete de gráficos ligero y optimizado para Julia, que funciona como el núcleo del ecosistema de JuliaGraphs. La próxima versión 2.0 de LightGraphs representa un cambio fundamental en la API de LightGraphs. Me aseguraré de que la documentación represente las funciones más recientes y avanzadas de LightGraphs.
- Entregables: Realizaré una auditoría de la documentación existente de la API para ver qué documentación puede mantenerse igual y analizar los cambios realizados en la versión 2.0 para asegurarme de que estén documentados correctamente con ejemplos. Durante este proceso, escribiré publicaciones en las que destacaré los cambios más importantes de la versión 2.0. Para ayudar a los recién llegados a comprender mejor LightGraphs, crearé guías para principiantes para quienes den sus primeros pasos en el mundo del uso de gráficos en Julia.
- Notas: En este proyecto, se usará Documenter.jl como generador de documentos para compilar los documentos de LightGraphs. Además de las referencias de la API para módulos como Coloring.jl, también las necesito para los submódulos como greedy_color.jl. Voy a explorar cómo agregarlas para renovar la documentación de LightGraphs. Además, la teoría de grafos es un campo bastante técnico de las matemáticas y es poco clara para quienes no tienen conocimientos matemáticos. He participado en investigaciones académicas durante aproximadamente 2 años y escribí varias entradas de blog en mi sitio web personal, por lo que tengo la confianza de explicar la esencia de los diferentes algoritmos y dar pistas sobre cuáles debo usar en diversas situaciones al crear las guías para principiantes.
Instructivos de JuliaGraphs: 10 semanas
- Descripción general: Muchas de las documentaciones de los paquetes de JuliaGraphs están orientadas a los desarrolladores. Agregaré algunos ejemplos simples y mostraré el uso de cada función para que sea más accesible para los usuarios.
- Entregables: Realizaré una auditoría de los instructivos existentes de LightGraphs para ver qué materiales deben agregarse y demostrar el uso y la motivación de cada función. Luego, seguiré la forma de JuliaGraphsTutorials para expandir los instructivos de JuliaGraphs, incluida la guía para principiantes en el ecosistema de LightGraphs.
- Notas: Actualmente, el contenido de JuliaGraphsTutorials no es lo suficientemente exhaustivo. Las entregas que se enumeran anteriormente son principalmente para el paquete LightGraphs. Si el tiempo lo permite, también agregaré instructivos para otros módulos en JuliaGraphs, como GraphPlot.jl, MetaGraphs.jl y SimpleWeightedGraphs.jl.
Sitio web central de JuliaGraphs: 4 semanas
- Descripción general: El sitio web central de JuliaGraphs ofrece una descripción general de los paquetes del ecosistema. Sin embargo, sigue siendo principalmente una descripción y se puede mejorar aún más para que se convierta en el primer recurso para que las personas comiencen a usar gráficos en Julia. Voy a encontrar una forma intuitiva con visualización para destacar las funciones de varios paquetes de JuliaGraphs.
- Entregables: Ofreceré casos de uso y ejemplos para destacar las funcionalidades de los paquetes de JuliaGraphs y realizaré una auditoría para asegurarme de que sigan siendo relevantes y compatibles. Crearé una sección que destaque los distintos usos de los distintos paquetes en distintos ámbitos (Salud, Educación, etc.) Si el tiempo lo permite, investigaré las explicaciones visuales de los algoritmos utilizados en los gráficos.
- Notas: Muchos paquetes de JuliaGraphs se han usado ampliamente en diferentes dominios. Además de las extensiones de trazado, como DiGraph para NetworkViz, algunas otras aplicaciones en temas específicos que incluiré son MetaGraph para BioStructures en Biología, DijkstraState para TrafficAssighnment en Planificación Urbana, DiGraph para TreeView en Educación, etc..