8000 🌍 We need your help for README translations!!! · Issue #73 · upstash/context7 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

🌍 We need your help for README translations!!! #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
enesgules 8000 opened this issue Apr 23, 2025 · 13 comments
Open

🌍 We need your help for README translations!!! #73

enesgules opened this issue Apr 23, 2025 · 13 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@enesgules
Copy link
Collaborator

Hey everyone!
We’re looking to make Context7 more accessible to devs around the world, and we’d love your help!

If you’re fluent in a language other than English and want to contribute, feel free to open a PR with a translated version of our README.

✅ What to do:

  • Translate the main README.md into your language
  • Save it as README.[lang-code].md (e.g. README.fr.md for French, README.tr.md for Turkish)
  • Put your file inside the /docs/ folder
  • Add a button to the main README.md (e.g. [![中文文档](https://img.shields.io/badge/docs-中文版-yellow)](./docs/README.zh-CN.md))
  • Mention the language in the PR title (e.g. [Translation] Turkish README)
@enesgules enesgules added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Apr 23, 2025
@enesgules enesgules pinned this issue Apr 23, 2025
@enesgules
Copy link
Collaborator Author
enesgules commented Apr 23, 2025 •
edited
Loading

We have Chinese: #70 thanks @duyifan02, @shown1985 and @shawninaction!

@enesgules
Copy link
Collaborator Author

We have Korean! #74 Thanks @coyaSONG

@enesgules
Copy link
Collaborator Author

We have Spanish! #84 Thanks @dsfaccini

@enesgules
Copy link
Collaborator Author

We have French! #100 Thanks @mmurdockk

@enesgules
Copy link
Collaborator Author

We have Portuguese (Brazil)! #122 Thanks @CarlosZiegler

@enesgules
Copy link
Collaborator Author

We have Indonesian! #126 Thanks @bangjohn

@enesgules
Copy link
Collaborator Author

We have Italian! #128 Thanks @raphaelabenom

@enesgules
Copy link
Collaborator Author

We have German! #132 Thanks @dsfaccini

@enesgules
Copy link
Collaborator Author

We have Russian! #145 Thanks @ladmol

@enesgules
Copy link
Collaborator Author

We have Turkish! #154 Thanks @ErdemCanK

@kkkkkom8
Copy link
kkkkkom8 commented May 7, 2025

Just wondering if the main README gets updated, how do we make sure the translated version also gets synced with updates?

@enesgules
Copy link
Collaborator Author

Just wondering if the main README gets updated, how do we make sure the translated version also gets synced with updates?

The main README gets updated and the translations do not. Any suggestions to solve this?

@ErdemCanK
Copy link
Contributor
ErdemCanK commented May 7, 2025 •
edited
Loading

Just wondering if the main README gets updated, how do we make sure the translated version also gets synced with updates?

The main README gets updated and the translations do not. Any suggestions to solve this?

💡 Suggestion: Translation Sync Check via Git Diff
Hi everyone,
Thanks for raising the concern about translation files becoming outdated when README.md is updated. Here's a lightweight and practical idea that could help maintain translation consistency:

✅ Idea: Simple Diff-Based Sync Checker
We could implement a basic script (e.g. in Node.js or Python) that compares the original README.md with each translated version using git diff --no-index. This script would:

Output the differences between the original and the translated README

Alert contributors if their translated file is out of sync

Optionally, exit with code 1 for CI use

This approach doesn’t require deep integration or ownership privileges—contributors can run it locally before opening a PR.

🧪 Example: Node.js Script

const { execSync } = require('child_process');
const diff = execSync('git diff --no-index README.md docs/README.tr.md', { encoding: 'utf-8' });
console.log(diff || '✅ Translation is up to date.');

⚙️ Optional GitHub Actions Integration
If maintainers are open to it, this script can also be added as a GitHub Action to run automatically on PRs that touch README.md or translated files. That way, we can gently remind contributors to update translations when needed.

If this sounds useful, I’d be happy to help prepare a working script or CI setup!

Thanks 🙌

@mmurdockk mmurdockk mentioned this issue May 9, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ErdemCanK @enesgules @kkkkkom8
0