Skip to content

Conversation

@LelouchFR
Copy link
Owner

@LelouchFR LelouchFR commented May 28, 2025

This PR introduces multi-language support for the project's documentation, aiming to improve accessibility and reach for a global audience. Each supported language has its own dedicated README file.

Warning

The languages having not been added here can be suggested in the issue #468 or directly in this PR. The PR description will be up to date with the requested Languages and the the assignees. If you want to work on a language, please write it under this PR and you will be assigned.

Implementation Details

Separate README files have been created for each supported language.
A language switcher has been added at the top of each README to easily navigate between versions.
This structure allows future contributors to easily add new languages without impacting existing content.

Directory Structure

.
├── README.md
└── .github
    └── READMES
        ├── README.de.md
        ├── README.es.md
        ├── README.fr.md
        └── README.hi.md

Supported Languages

What to do after that ?

  • Update the readme-format.sh script to handle the language changes

closes #468

* add README.hi.md

---------

Co-authored-by: 이희연 HeeYeon Lee <up2kid@gmail.com>
@LelouchFR LelouchFR added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels May 28, 2025
@LelouchFR LelouchFR marked this pull request as draft May 28, 2025 20:04
@LelouchFR LelouchFR self-assigned this May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEAT]: Add Multi-Language Support to Documentation

3 participants