Skip to content

Commit 80e1724

Browse files
committed
Tweak README
1 parent 952b9ff commit 80e1724

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

.github/workflows/main.yml

-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ jobs:
5252
GITHUB_EMAIL: ${{ secrets.DEPLOY_GITHUB_EMAIL }}
5353
GIT_USER: ${{ secrets.DEPLOY_GITHUB_USER }}
5454
CURRENT_BRANCH: $GITHUB_REF
55-
STABLE_RELEASE: true
5655
run: |
5756
git config --global user.email "$GITHUB_EMAIL"
5857
git config --global user.name "$GITHUB_ACTOR"

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,35 @@ Want to help improve the documentation? That would be so very much appreciated.
44

55
## Philosophy of documentation
66

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.
1010

1111
## Things anyone can do
1212

1313
### Run it locally
1414

1515
1. Clone the repository
16-
2. Run `yarn` (or `npm install`)
16+
2. Run `yarn`
1717
3. `yarn start`
1818

1919
### Make changes
2020

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.
2323

2424
## Things you need to be a collaborator to do
2525

26+
_Deployment is done automatically via Github Actions. Normally you shouldn't need to do these._
27+
2628
### Download the latest translations
2729

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).
2931
- Run `yarn crowdin-upload` and then `yarn crowdin-download`
3032

3133
### Deploy it
3234

33-
*Before deploying, be sure to download the latest translations!*
35+
_Before deploying, be sure to download the latest translations!_
3436

3537
Only collaborators on this repository can deploy. Run the following command from the `source` branch:
3638

0 commit comments

Comments
 (0)