Skip to content

Commit

Permalink
docs: recommend node 16 instead of node 14 (#3274)
Browse files Browse the repository at this point in the history
* docs: recommend node 16 instead of node 14

* ci: use node 16 in semaphore ci

* ci: use node 16 in github actions

* style: apply automatic linting to teaching_philosophy.md
  • Loading branch information
kantord committed Feb 3, 2024
1 parent c5f2f94 commit e67a59a
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
fail-fast: false
matrix:
python-version: ["3.9"]
node-version: ["14"]
node-version: ["16"]
os: [ubuntu-20.04]
defaults:
run:
Expand Down
12 changes: 6 additions & 6 deletions .semaphore/semaphore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ blocks:
jobs:
- name: yarn install
commands:
- sem-version node 14
- sem-version node 16
- checkout
- cache restore
- cache restore node-$(checksum yarn.lock)
Expand All @@ -28,7 +28,7 @@ blocks:
jobs:
- name: yarn jest
commands:
- sem-version node 14
- sem-version node 16
- checkout
- cache restore node-$(checksum yarn.lock)
- yarn jest
Expand All @@ -39,7 +39,7 @@ blocks:
jobs:
- name: cypress and percy
commands:
- sem-version node 14
- sem-version node 16
- checkout
- cache restore node-$(checksum yarn.lock)
- cache restore cypress-$(checksum yarn.lock)
Expand All @@ -60,7 +60,7 @@ blocks:
jobs:
- name: yarn lint
commands:
- sem-version node 14
- sem-version node 16
- checkout
- cache restore node-$(checksum yarn.lock)
- yarn lint
Expand All @@ -71,7 +71,7 @@ blocks:
jobs:
- name: yarn types
commands:
- sem-version node 14
- sem-version node 16
- checkout
- cache restore node-$(checksum yarn.lock)
- cache restore packages-web-$(checksum yarn.lock)
Expand All @@ -83,7 +83,7 @@ blocks:
jobs:
- name: yarn web export
commands:
- sem-version node 14
- sem-version node 16
- checkout
- cache restore node-$(checksum yarn.lock)
- cache restore cypress-$(checksum yarn.lock)
Expand Down
2 changes: 1 addition & 1 deletion apps/docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ RUN git clone https://github.com/LibreLingo/LibreLingo.git --single-branch
WORKDIR /LibreLingo

# Install node dependencies
RUN source $NVM_DIR/nvm.sh && nvm install 14 && nvm use 14 && yarn install
RUN source $NVM_DIR/nvm.sh && nvm install 16 && nvm use 16 && yarn install

# Install poetry
RUN curl -sSL https://install.python-poetry.org | python -
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,13 @@ In order to make sure you have the correct `node` version, it's recommended to u
First, install the correct `node` version with this command:

```bash
nvm install 14
nvm install 16
```

Then, to choose this version of `node` in your terminal, use

```bash
nvm use 14
nvm use 16
```

#### Install dependencies:
Expand Down
4 changes: 3 additions & 1 deletion docs/teaching_philosophy.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Looking at the big picture, the greater approach of LibreLingo is to fully embra
## What is the reasoning behind the set of challenges present, and the way they are designed?

LibreLingo has five types of challenges:

- **Cards challenges** are multiple choice questions that create associations between words and images. Visual association is a powerful learning technique, especially for simple words, and the images add fun and vibrancy to the learning experience. The photos also provide clues to the student, making this one of the easier challenges.
- **Options challenges** are multiple choice questions that allow students to become comfortable with phrases, rather than single words. Unlike the card challenges, there are no clues.
- **Short input challenges** serve to teach the target language's native writing system by requiring the learner to spell a word. If the student does need a hint, the mini-dictionary is available for this challenge.
Expand All @@ -26,8 +27,9 @@ First, a random subset of words and phrases are selected. Challenges are generat
Challenges are split randomly into different levels so that you have smaller chunks of learning material for each skill, without requiring the course authors to create very small units manually. This also makes the general overview of a course more manageable as it reduces the overall number of skills needed in a course.

Challenges are split randomly for the following reasons:

- There's often a partial overlap between each level of a skill, thus it offers some repetition even before completing the skill.
- Randomness reduces fatigue by making the practice sessions less predictable. It also reduces boredom by increasing the chance of encountering new words even as you practice the same skill by partially practicing material from a previous level.
- Random splits do not require any manual work from the course creator.

For more insights on the creation of LibreLingo, check out the article ['Why I Built LibreLingo'](https://dev.to/kantord/why-i-built-librelingo-280o) by creator Daniel Kantor.
For more insights on the creation of LibreLingo, check out the article ['Why I Built LibreLingo'](https://dev.to/kantord/why-i-built-librelingo-280o) by creator Daniel Kantor.

0 comments on commit e67a59a

Please sign in to comment.