jerdra/niviz-rater

DOC: Initial documentation

Open

#4 opened on Dec 7, 2021

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

Repository metrics

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

Description

The following documentation components would be good to cover for new users:

Getting started

  1. Tutorial dataset (host images on OSF) + expected dataset structure
  2. YAML specification for constructing views
  3. UI overview (grouping, shortcuts)

Contributor guide

Research direction
Review the current repository structure and any existing documentation. Explore the application to understand how views are configured via YAML. Gather screenshots and examples for the user guide. Check the README for setup instructions to run the app locally.
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
80