anuraghazra/github-readme-stats

Migrate to automatic README translation

Open

#2,053 opened on Sep 25, 2022

View on GitHub
 (27 comments) (0 reactions) (0 assignees)JavaScript (79,424 stars) (33,282 forks)batch import
enhancementhelp wanted

Description

Is your feature request related to a problem? Please describe.

Keeping the documentation up to date and managing the PRs would be more manageable if we switched from manual to automatic README translations (see https://github.com/dephraiim/translate-readme). The downside is that there might be some errors, but this shouldn't matter for understanding how to use GRS. Google has become quite good at translating languages in the last few years. The upside is that we no longer need to look at translation PRs, we can support more language, and the translations are up to date. We can add flags to the readme for people to choose their language.

Contributor guide

Tech stack
javascript
Domain
documentationinternationalization
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitHub ActionsYAMLTranslation tool setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Research the translate readme action by dephraiim to understand its setup and configuration. Examine the current README structure in the repository to determine how multiple language versions are managed. Review existing comments (e.g., #2053) for maintainer feedback on preferred approach. Consider which file(s) need modification, likely .github/workflows/translate.yml, and propose a workflow that generates translated readmes for specified languages.