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. cd into thewebsite directory.
3. Runyarn (ornpm install)
4. yarn start

• Thedocs directory contains the markdown files used to generate the website. 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 tosidebars.json and then restart the server.

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

Before deploying, be sure to download the latest translations!

Only collaborators on this repository can deploy.cd into the website directory and run the following command from thesource branch:

GIT_USER=your_github_username \STABLE_RELEASE=true \CURRENT_BRANCH=source \USE_SSH=true \yarn run publish-gh-pages