Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lewtun committed Mar 28, 2022
1 parent a987a70 commit 7df3d56
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,18 @@ Here, `CHAPTER-NUMBER` refers to the chapter you'd like to work on and `LANG-ID`

**✍️ Start translating**

Now comes the fun part - translating the text! The first thing we recommend is translating the `_toctree.yml` file. This file is used to render the table of contents on the website and provide the links to the Colab notebooks. The only fields you should change are `title`, `subtitle`, and `sections`. For example, here are the parts of `_toctree.yml` that we'd translate for [Chapter 0](https://huggingface.co/course/chapter0/1?fw=pt):
Now comes the fun part - translating the text! The first thing we recommend is translating the part of the `_toctree.yml` file that corresponds to your chapter. This file is used to render the table of contents on the website and provide the links to the Colab notebooks. The only fields you should change are the `title`, ones -- for example, here are the parts of `_toctree.yml` that we'd translate for [Chapter 0](https://huggingface.co/course/chapter0/1?fw=pt):

```yaml
- title: 0. Setup # Translate this!
subtitle: This course looks cool, how can I run its code?
sections:
- local: chapter0/1 # Do not change this!
title: Introduction # Translate this!
```
Once you have translated the `_toctree.yml` file, you can start translating the [MDX](https://mdxjs.com/) files associated with each chapter.
Once you have translated the `_toctree.yml` file, you can start translating the [MDX](https://mdxjs.com/) files associated with your chapter.

> 🙋 If the `_toctree.yml` file doesn't yet exist for your language, you can simply create one by copy-pasting from the English version and deleting the sections that aren't related to your chapter. Just make sure it exists in the `chapters/LANG-ID/` directory!

## 📔 Jupyter notebooks

Expand Down
6 changes: 3 additions & 3 deletions chapters/en/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sections:
- local: chapter0/1
title: Introduction

- title: 1. Transformer models
sections:
- local: chapter1/1
Expand All @@ -26,7 +26,7 @@
- local: chapter1/10
title: End-of-chapter quiz
quiz: 1

- title: 2. Using 🤗 Transformers
sections:
- local: chapter2/1
Expand All @@ -46,7 +46,7 @@
- local: chapter2/8
title: End-of-chapter quiz
quiz: 2

- title: 3. Fine-tuning a pretrained model
sections:
- local: chapter3/1
Expand Down

0 comments on commit 7df3d56

Please sign in to comment.