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
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,9 @@ yarn
15
15
yarn pull-en
16
16
17
17
# Optional: Verify your changes will correctly replace the english files
18
-
yarn validate-paths
18
+
yarn lint
19
+
# Alternative: Run the lint watcher
20
+
yarn lint --watch
19
21
```
20
22
21
23
That's it, you've got a copy of all the documentation and now can write documentation which follows the existing patterns.
@@ -46,7 +48,8 @@ For example if you wanted to translate a new handbook page you would:
46
48
- Pull in the English files `yarn pull-en` (these will be gitignored)
47
49
- Find your english file: `docs/documentation/en/handbook-v2/Basics.md`
48
50
- Recreate the same folder path in your language: `docs/documentation/it/handbook-v2/Basics.md`
49
-
- Translate the file!
51
+
- Translate the file!
52
+
- Validate your changes: `yarn lint` (or `yarn lint docs/documentation/it/handbook-v2/Basics.md`)
50
53
- Create a pull request to this repo
51
54
- Once merged, the translation will appear on the next website deploy
52
55
@@ -56,12 +59,14 @@ When a new language is created, we ask for a few people to become language owner
56
59
57
60
The TypeScript team generally only know English, and can answer clarifying questions if needed! For quick questions, you can use the `ts-website-translation` channel in the [TypeScript Discord](https://discord.gg/typescript).
58
61
59
-
#### Well tested
62
+
#### Secure
60
63
61
64
This repo has extensive CI to ensure that you can't accidentally break the TypeScript website.
62
65
63
66
There are local, fast checks that it won't break via `yarn test` and then the full TypeScript website test suite runs with the changes, and a website build is generated to ensure that nothing breaks.
64
67
68
+
The checks may not seem obvious to an outsider, because the website is complex, so there is a watch mode which you can run via `yarn link --watch` to get instant feedback.
69
+
65
70
# Contributing
66
71
67
72
This project welcomes contributions and suggestions. Most contributions require you to agree to a
0 commit comments