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 (523 stars) (69 forks)batch import
help wanted

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

Tech stack
javascriptreactreact native
Domain
documentationmobile
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React Native basicsExNavigator API understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Focus on identifying all props of ExNavigator by reading the source code, particularly the main component file. Look at the existing README for current documentation gaps. The issue comments may contain additional suggestions from maintainers. Write clear, concise descriptions and code examples for each prop.