expo/ex-navigator

Looking for help with documentation

Open

#18 opened on Oct 29, 2015

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (69 forks)batch import
help wanted

Repository metrics

Stars
 (523 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Some more documentation around what props are supported and what they do would be pretty useful along with a short example. The blog post explains why ExNavigator is the way it is but doesn't comprehesively detail all the props. If anyone has suggestions for how to nicely format the docs (w/a preference to legibility more than prettiness) something more than a README would be nice.

Contributor guide

Research direction
Review the existing documentation and props, then propose a structured format using markdown or a documentation tool. Consider including code examples for each prop.
Tech stack
javascriptreact
Domain
mobile
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.
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.
80