Repository files navigation

Want to help improve the documentation? That would be so very much appreciated. Some information on that below.

• Document the ugly parts as much as the good parts. It's better for users to know that we don't have a good solution to the problem they have and get the preferred workarounds from us than have to scour the dark and moist corners of StackOverflow.
• Provide runnable examples where possible. Learning through interacting with the code is a reason why REPLs are so popular. Thanks toSnack we can provide the same kind of experience for React Navigation users too.
• Be honest about the tradeoffs and limitations. We explain the pitch and anti-pitch of React Navigation and provide alternative libraries if React Navigation might not be a good fit. We should provide a similar level of honesty at finer levels of granularity as well.

1. Clone the repository
2. Runyarn
3. yarn start

• Each documentation version ofreact-navigation is generated by the markdown files located inversioned_docs. Change them and refresh the page when running the documentation locally and you will see the changes reflected.
• If you want to add a new page, you need to add it to the correspondingsidebars.json file and then restart the server.

Deployment is done automatically via Github Actions. Normally you shouldn't need to do these.

• ConfigureCROWDIN_DOCUSAURUS_PROJECT_ID andCROWDIN_DOCUSAURUS_API_KEY environment variables (ask@brentvatne if you need access).
• Runyarn crowdin-upload and thenyarn crowdin-download

• Create a Github "Personal Access Token"here and set theread:org scope on it.
• Set the environment variableREACT_NAV_GITHUB_TOKEN to that value.
• Runyarn fetch-sponsors.
• Commit the updatedsponsors.js file.

Before deploying, be sure to download the latest translations!

Only collaborators on this repository can deploy. Run the following command from themain branch:

GIT_USER=<Your GitHub username> \CURRENT_BRANCH=main \USE_SSH=true \yarn deploy

MIT License