Skip to content

Commit

Permalink
Set up the translation
Browse files Browse the repository at this point in the history
  • Loading branch information
gaearon committed May 18, 2023
1 parent bea2ff7 commit 9f92d43
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# react.dev
# si.react.dev

This repo contains the source code and documentation powering [react.dev](https://react.dev/).
This repo contains the source code and documentation powering [si.react.dev](https://si.react.dev/).

## Getting started

Expand All @@ -10,11 +10,11 @@ This repo contains the source code and documentation powering [react.dev](https:
1. Node: any 12.x version starting with v12.0.0 or greater
1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/)
1. A fork of the repo (for any contributions)
1. A clone of the [react.dev repo](https://github.com/reactjs/react.dev) on your local machine
1. A clone of the [si.react.dev repo](https://github.com/reactjs/si.react.dev) on your local machine

### Installation

1. `cd react.dev` to go into the project root
1. `cd si.react.dev` to go into the project root
3. `yarn` to install the website's npm dependencies

### Running locally
Expand All @@ -26,11 +26,11 @@ This repo contains the source code and documentation powering [react.dev](https:

### Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the [contributing guidelines](https://github.com/reactjs/react.dev/blob/main/CONTRIBUTING.md#guidelines-for-text) for the appropriate sections.
The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the [contributing guidelines](https://github.com/reactjs/si.react.dev/blob/main/CONTRIBUTING.md#guidelines-for-text) for the appropriate sections.

### Create a branch

1. `git checkout main` from any folder in your local `react.dev` repository
1. `git checkout main` from any folder in your local `si.react.dev` repository
1. `git pull origin main` to ensure you have the latest main code
1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch

Expand All @@ -51,13 +51,13 @@ The documentation is divided into several sections with a different tone and pur

1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fix header logo on Android`) to stage and commit your changes
1. `git push my-fork-name the-name-of-my-branch`
1. Go to the [react.dev repo](https://github.com/reactjs/react.dev) and you should see recently pushed branches.
1. Go to the [si.react.dev repo](https://github.com/reactjs/si.react.dev) and you should see recently pushed branches.
1. Follow GitHub's instructions.
1. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.

## Translation

If you are interested in translating `react.dev`, please see the current translation efforts [here](https://github.com/reactjs/react.dev/issues/4135).
If you are interested in translating `si.react.dev`, please see the current translation efforts [here](https://github.com/reactjs/si.react.dev/issues/4135).

## License
Content submitted to [react.dev](https://react.dev/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](https://github.com/reactjs/react.dev/blob/main/LICENSE-DOCS.md) file.
Content submitted to [si.react.dev](https://si.react.dev/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](https://github.com/reactjs/si.react.dev/blob/main/LICENSE-DOCS.md) file.

0 comments on commit 9f92d43

Please sign in to comment.