You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8
Original file line number
Diff line number
Diff line change
@@ -4,33 +4,35 @@ Want to help improve the documentation? That would be so very much appreciated.
4
4
5
5
## Philosophy of documentation
6
6
7
-
-*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.
8
-
-*Provide runnable examples where possible.* Learning through interacting with the code is a reason why REPLs are so popular. Thanks to [Snack](https://snack.expo.io) we can provide the same kind of experience for React Navigation users too.
9
-
-*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.
7
+
-_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.
8
+
-_Provide runnable examples where possible._ Learning through interacting with the code is a reason why REPLs are so popular. Thanks to [Snack](https://snack.expo.io) we can provide the same kind of experience for React Navigation users too.
9
+
-_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.
10
10
11
11
## Things anyone can do
12
12
13
13
### Run it locally
14
14
15
15
1. Clone the repository
16
-
2. Run `yarn` (or `npm install`)
16
+
2. Run `yarn`
17
17
3.`yarn start`
18
18
19
19
### Make changes
20
20
21
-
* The `docs` 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.
22
-
* If you want to add a new page, you need to add it to [sidebars.json](https://github.com/react-navigation/react-navigation.github.io/blob/source/sidebars.json) and then restart the server.
21
+
- The `docs` 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.
22
+
- If you want to add a new page, you need to add it to [sidebars.json](https://github.com/react-navigation/react-navigation.github.io/blob/source/sidebars.json) and then restart the server.
23
23
24
24
## Things you need to be a collaborator to do
25
25
26
+
_Deployment is done automatically via Github Actions. Normally you shouldn't need to do these._
27
+
26
28
### Download the latest translations
27
29
28
-
- Configure `CROWDIN_DOCUSAURUS_PROJECT_ID` and `CROWDIN_DOCUSAURUS_API_KEY` environment variables (ask @brentvatne if you need access).
30
+
- Configure `CROWDIN_DOCUSAURUS_PROJECT_ID` and `CROWDIN_DOCUSAURUS_API_KEY` environment variables (ask [@brentvatne](https://github.com/brentvatne) if you need access).
29
31
- Run `yarn crowdin-upload` and then `yarn crowdin-download`
30
32
31
33
### Deploy it
32
34
33
-
*Before deploying, be sure to download the latest translations!*
35
+
_Before deploying, be sure to download the latest translations!_
34
36
35
37
Only collaborators on this repository can deploy. Run the following command from the `source` branch:
0 commit comments