LouisPauchet/UNIS_SvalbardWeatherInformation

Create a documentation

Open

#20 opened on Nov 18, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (1 fork)auto 404
V1documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

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/

Contributor guide

Research direction
Review the mkdoc configuration and existing docstrings in the Python code to understand the app's functionality, then write markdown documentation for end users, administrators, and developers following the structure in ./docs/.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85