Skip to content

Commit 6a8254b

Browse files
committed
Improve documentation
1 parent 8ca537a commit 6a8254b

File tree

2 files changed

+41
-4
lines changed

2 files changed

+41
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# GDevelop-tutorials
22

3-
![GDevelop logo](https://raw.githubusercontent.com/4ian/GDevelop/master/newIDE/GDevelop%20banner.png "GDevelop logo")
3+
![GDevelop logo](https://raw.githubusercontent.com/4ian/GDevelop/master/newIDE/GDevelop%20banner.png 'GDevelop logo')
44

55
This repository holds official tutorials for the [GDevelop](https://gdevelop.io) editor.
66

77
At the moment, tutorials can only take the form of an in-app tutorial that guides a user step by step into accomplishing a specific task or discovering a whole part of the editor.
88

99
## Getting Started
1010

11-
| ❔ I want to... | 🚀 What to do |
12-
| ------------------------------- | ------------------------------------------------------------------------------ |
13-
| Create an in-app tutorial | First read [this README](./docs/inAppTutorial/README.md) and then submit a new tutorial of your own |
11+
| ❔ I want to... | 🚀 What to do |
12+
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
13+
| Create an in-app tutorial | Head over to [this README](./docs/inAppTutorial/README.md) to understand how the tutorial files are structured and then submit a new tutorial of your own. |
14+
| Help to translate existing in-app tutorials | Head over to [this README](./docs/inAppTutorial/README.md) to understand how we store translations and then submit with your suggestion. |

docs/inAppTutorial/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,39 @@ You can have a look at the components in [the editor storybook](https://gdevelop
1010
## How To Create An In-App Tutorial
1111

1212
Have a look at the [documentation](./REFERENCE.md) to learn how to build your JSON.
13+
14+
## Add a New Language to an In-App Tutorial
15+
16+
> Make sure you're comfortable with editing [JSON files](https://docs.fileformat.com/web/json/).
17+
18+
To help us translate the in-app tutorials, please follow these steps:
19+
20+
- Git and GitHub manipulations:
21+
- Fork the repository
22+
- Create a new branch in your new repository
23+
24+
Once the repository is installed, open the JSON file with your favorite IDE (VSCode or else.) and begin the translation work:
25+
26+
- Find all the lines corresponding to a field with key `"en"` and duplicate those lines
27+
- with VSCode, select `"en"` and then hit Ctrl+Shift+L to select all identical occurrences.
28+
- Translate each new line you created with the above instruction
29+
- Add the locale you added to field `availableLocales`
30+
31+
**Notes**
32+
33+
- There are a few things to know, you can have a look at the other translations if you're not sure:
34+
- We're using markdown to format the text. For instance:
35+
- **\*\*bold\*\***
36+
- \*_italic_\*
37+
- `` `code` ``
38+
- There shall not be empty translations
39+
- Don't translate placeholders such as `$(character)`
40+
41+
And finally:
42+
43+
- Git and GitHub manipulations:
44+
- Commit your changes
45+
- Push your branch
46+
- Open the PR from your branch to our `main` branch.
47+
48+
Once you do this, a few automated checks will be run to make sure a few basic verifications are made.

0 commit comments

Comments
 (0)