pypsa-meets-earth/pypsa-earth

Re-order installation instructions

Open

#1,105 opened on Sep 20, 2024

View on GitHub
 (0 comments) (2 reactions) (0 assignees)Python (349 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (Avg merge 28d 15h) (35 merged PRs in 30d)

Description

Describe the feature you'd like to see

Move the installation instructions to the documentation website since the docs are maintained regularly. This will be very helpful for new users as it will help them get started with the application easily.

Contributor guide

Research direction
Review current installation instructions in the README and on the documentation website. Identify key steps and suggest a reorganized structure that moves detailed instructions to the docs, while keeping a concise quick start in the README.
Tech stack
python
Domain
documentationdeveloper experience
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.
Under 1 hour
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
Gitbasic Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85