Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Langage Julia
- Rédacteur technique:
- Shuo Liu
- Nom du projet:
- Documentation LightGraphs 2.0 et tutoriels JuliaGraphs conviviaux
- Durée du projet:
- Longue durée (5 mois)
Project description
Dans ce projet de longue durée, je vais améliorer le site Web et la documentation des modules dans JuliaGraphs. Plus précisément, mon travail comprendra, mais sans s'y limiter, les éléments suivants.
LightGraphs Docs 2.0 - 10 Weeks
- Présentation: LightGraphs.jl est un package de graphiques léger optimisé pour Julia, qui constitue le cœur de l'écosystème JuliaGraphs. La prochaine version 2.0 de LightGraphs représente un changement fondamental dans l'API LightGraphs. Je veillerai à ce que la documentation présente les dernières et meilleures fonctionnalités de LightGraphs.
- Livrables: Je vais effectuer un audit des documents de l'API existants pour voir quels documents peuvent rester les mêmes et analyser les modifications apportées à la version 2.0 pour m'assurer qu'elles sont correctement documentées avec des exemples. Au cours de ce processus, je publierai des articles qui mettront en avant les principaux changements de la version 2.0. Pour aider les nouveaux utilisateurs à mieux comprendre LightGraphs, je vais créer des guides pour les débutants qui font leurs premiers pas dans l'utilisation des graphiques en Julia.
- Remarques: Dans ce projet, Documenter.jl sera utilisé comme générateur de documents pour créer la documentation LightGraphs. En plus des références d'API pour des modules tels que Coloring.jl, j'en ai également besoin pour les sous-modules tels que greedy_color.jl. Je vais voir comment les ajouter pour renouveler la documentation LightGraphs. De plus, la théorie des graphes est un domaine mathématique assez technique et obscur pour ceux qui n'ont pas de formation mathématique. Je mène des recherches universitaires depuis environ deux ans et j'ai écrit de nombreux articles de blog sur mon site Web personnel. Je suis donc à même d'expliquer l'essentiel des différents algorithmes et de donner des indications sur ceux à utiliser dans différentes situations lorsque je crée des guides pour les débutants.
Tutoriels JuliaGraphs – 10 semaines
- Présentation: De nombreuses documentations des packages JuliaGraphs sont destinées aux développeurs. Je vais ajouter quelques exemples simples et illustrer l'utilisation de chaque fonctionnalité afin de la rendre plus accessible aux utilisateurs.
- Livrables: Je vais effectuer un audit des tutoriels LightGraphs existants pour déterminer les éléments à ajouter et montrer l'utilisation et la motivation de chaque fonctionnalité. Je vais ensuite suivre la méthode de JuliaGraphsTutorials pour développer des tutoriels JuliaGraphs, y compris un guide pour les débutants dans l'écosystème LightGraphs.
- Remarques: Le contenu de JuliaGraphsTutorials n'est pas assez complet à l'heure actuelle. Les livrables listés ci-dessus concernent principalement le package LightGraphs. Si le temps me le permet, j'ajouterai également des tutoriels pour d'autres modules de JuliaGraphs, tels que GraphPlot.jl, MetaGraphs.jl et SimpleWeightedGraphs.jl.
Site Web central de JuliaGraphs – 4 semaines
- Présentation: le site Web central de JuliaGraphs offre un aperçu des packages de l'écosystème. Cependant, il s'agit encore principalement d'une description et peut être encore améliorée pour devenir la première ressource pour les personnes qui débutent avec les graphiques dans Julia. Je vais trouver un moyen intuitif de mettre en avant les fonctionnalités des différents packages JuliaGraphs à l'aide de visualisations.
- Livrables: je proposerai des cas d'utilisation et des exemples pour mettre en évidence les fonctionnalités des packages JuliaGraphs, et je réaliserai un audit pour s'assurer qu'ils sont toujours pertinents et pris en charge. Je vais créer une section qui met en avant les différentes utilisations des différents packages dans différents domaines (santé, éducation, etc.). Si le temps me le permet, je rechercherai des explications visuelles des algorithmes utilisés dans Graphs.
- Remarques: De nombreux packages JuliaGraphs ont été largement utilisés dans différents domaines. En plus des extensions de tracé telles que DiGraph for NetworkViz, je vais inclure d'autres applications dans des sujets spécifiques, comme MetaGraph for BioStructures en biologie, DijkstraState for TrafficAssighnment en urbanisme, DiGraph for TreeView dans l'éducation, etc..