ThinkR-open/inca3

Pimp the documentation

Open

#7 opened on Nov 30, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)R (0 forks)auto 404
documentationgood first issuehacktoberfest-accepted

Repository metrics

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

Description

It's currently hard to navigate through the various dataset:

  • Help pages are not informative: column with types doesn't help understanding what they mean, and description + usage doesn't inform about the content of the dataset

Screenshot 2020-11-30 at 09 54 47

  • Home page just displays the name of the dataset

Screenshot 2020-11-30 at 09 55 58

Given that a lot of these are described in the Vignette, I suggest we reuse these information inside the dataset documentation?

Contributor guide

Research direction
Examine the vignettes and extract descriptive text for each dataset, then integrate that information into the dataset documentation files (e.g., using roxygen2) to provide clearer help pages and a more informative home page.
Tech stack
r
Domain
documentationdata
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.
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
Rroxygen2
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70