lisphilar/covid19-sir

[Docs] documentation with both of stable and development version

Open

#1,186 opened on Sep 9, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Jupyter Notebook (44 forks)auto 404
documentationhelp wanted

Repository metrics

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

Description

What we need to document?

We have documentation with development version. It may be confusing when users uses the latest stable version because the stable version may not have some functionalities.

Contributor guide

Research direction
Focus on creating two documentation branches or using versioned docs to differentiate between stable and development versions.
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.
2
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90