LouisPauchet/UNIS_SvalbardWeatherInformation

Create a documentation

Ouverte

#20 ouverte le 18 nov. 2024

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Python (1 fork)auto 404
V1documentationenhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (3 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

The goal of this issue is to create documentation for both the end user to which he/she can relate, for the administrator and for the dev.

The documentation is using mkdoc to automatically generate documentation from docstrings in the python code. The user documentation should explain how to use the app Svalbard Weather Information (demo).

It's written in markdown and stored in ./docs/

Guide contributeur

Direction de recherche
Examinez la configuration de mkdoc et les docstrings existants dans le code Python pour comprendre les fonctionnalités de l'application, puis rédigez la documentation en markdown pour les utilisateurs finaux, les administrateurs et les développeurs en suivant la structure dans ./docs/.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85