react-navigation / react-navigation/react-navigation.github.io

Document Routers in API section

Open
#107 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
JavaScript
Stars
324
Forks
2k
PR merge metrics
No merged PRs in 30d

Description

We expose routers independently from react-navigation, but they aren't documented

  • StackRouter
  • TabRouter
  • DrawerRouter
  • SwitchRouter

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the API documentation section and review how existing router APIs are documented. Add entries for StackRouter, TabRouter, DrawerRouter, and SwitchRouter, with each independently exposed router covered; done means all four appear in the API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.