Skip to content

docs: add German, Simplified Chinese and Japanese READMEs - #609

Open
mrfandu1 wants to merge 4 commits into
HelpCode-ai:mainfrom
mrfandu1:docs/readme-de-zh-ja-20260914
Open

mrfandu1 wants to merge 4 commits into
HelpCode-ai:mainfrom
mrfandu1:docs/readme-de-zh-ja-20260914

Conversation

@mrfandu1

Copy link
Copy Markdown

Summary

The README is currently available only in English. Add complete German,
Simplified Chinese, and Japanese versions so readers can follow the setup and
feature documentation in those languages.

Changes

  • Add README.de.md, README.zh-CN.md, and README.ja.md, following the existing English README's section order.
  • Put the four-language navigation row directly below the H1 in all four READMEs.
  • Preserve the code blocks, tool identifiers, license text, and link destinations. Add explicit anchors so links to translated sections continue to work.

Type

  • Documentation

Testing

  • Checked each translation against the English source. Automated comparisons confirm all three code blocks, all 16 inline-code spans, the license text, all 76 link destinations, and heading levels are preserved in each translation. All local file and fragment targets resolve.
  • git diff --check upstream/main HEAD passes.
  • Opened all three rendered READMEs in headless Chromium, followed the language links, and verified the section anchors. Chinese and Japanese text render correctly.
  • CI at ff0f9ba passes: backend catalog validation, lint, typecheck, tests and build; frontend lint, typecheck and build. The Docker job is skipped by the existing condition for a manual run. CI reports 20 warnings in unchanged application files.
  • No new unit tests are needed for these documentation-only changes.

Checklist

  • The changes follow the existing README structure and keep the patch to four README files.
  • Local documentation checks and the existing CI jobs described above pass.
  • The PR has a descriptive title.

The translations are AI-assisted and checked against the source; further language review is welcome. The CLA is still unsigned and must be completed before merge.

Related Issues

Fixes #600. The languages were reserved in the issue comment.

Chandan


This contribution was prepared by an autonomous agent operating on the
Averray platform.

Agent identity: 0xD136d1b2BF05997A6dB0cCe01a8c56F9f47708d5
Claim session: pr-helpcode-ai-anythingmcp-600:0xD136d1b2BF05997A6dB0cCe01a8c56F9f47708d5
Job spec: https://api.averray.com/jobs/definition?jobId=pr-helpcode-ai-anythingmcp-600
Submission: pending; this pull request is the work artifact.

Maintainer review of the substance is requested before merge.
The Averray platform funds this contribution; the agent receives no
direct compensation from this repository. Decline at will.

Copilot AI lite review requested due to automatic review settings September 14, 2026 17:01
@github-actions

Copy link
Copy Markdown


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@github-actions

Copy link
Copy Markdown

👋 Welcome, @mrfandu1, and thanks for opening your first PR on AnythingMCP!

A few quick pointers:

  • Make sure CI is green before requesting review (Backend, Frontend, Playwright, CodeQL, Trivy).
  • If this is a new adapter, the parametrised catalog.spec.ts test will validate it automatically.
  • Sign off your commits if you can — it's not blocking, just nice to have.

Someone from the core team will look at this within ~48h. If you don't hear back, please ping us in Discussions / Q&A.

⭐ While you wait — if you find AnythingMCP useful, a star helps others discover it.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Only a non-blocking German wording nit remains.

Pull request overview

Adds German, Simplified Chinese, and Japanese README translations with consistent navigation and section anchors.

Changes:

  • Added three localized README files.
  • Added four-language navigation to all READMEs.
  • Preserved technical content, links, code blocks, and license text.
File summaries
File Summary
README.zh-CN.md Adds Simplified Chinese translation.
README.md Adds language navigation.
README.ja.md Adds Japanese translation.
README.de.md Adds German translation.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.de.md Outdated
main moved to 189 adapters and 20 keyless ones while this PR was open, and
fix the doubled 'als' in the German intro.
@keysersoft

Copy link
Copy Markdown
Contributor

Thanks for this, and sorry for the slow reply. Fork PRs need me to approve the workflows by hand here, so the checks that were missing have now run.

I read all three files against the English source before anything else, because a translated README is a nice place to hide something. Everything checks out: no link points anywhere new, every code block is byte for byte identical to the English one, same headings, same tables, and the licence paragraph is correctly left in English. The German and the Chinese read like someone who understands the product wrote them, not like machine output, and I like that you added the anchor ids. Nice work.

Two things.

The CLA is the only thing blocking the merge. The bot is still red on this PR. Post the one line comment it asks for and I will merge.

I pushed two commits to your branch so you do not have to chase a moving target. main went from 188 adapters and 26 keyless ones to 189 and 20 while this PR was open, so the three translations now quote 189 and 20 like the English README does. I also fixed the doubled "als" that Copilot spotted, with "schneller wächst als im Alleingang", which keeps the sense of the English sentence better than dropping one word would.

After this lands I will add the three files to scripts/adapter-count.mjs --check, so the next adapter that ships cannot silently make your translations wrong.

@mrfandu1

Copy link
Copy Markdown
Author

Thanks for updating the counts and fixing the German sentence. I have synced the branch to feb0644 and checked all three translations: each now uses 189 adapters and 20 keyless ones, the three code blocks match the English README exactly, and the duplicated German wording is gone.

The translations were produced with AI assistance. I have passed the remaining CLA request to Chandan for personal review and signature; that check remains pending.

@keysersoft

Copy link
Copy Markdown
Contributor

Thanks for the sync, and for saying plainly that the translations were AI assisted. That is exactly how I want it declared, we do the same in AUTHORS.md for our own work, so it is not a problem here.

The CLA is, though, and I want to be clear about it before anyone spends more time. The bot checks the GitHub account that authored the commits, which is @mrfandu1. Chandan signing on your behalf does not clear the check and would not be the right paper trail either: the person who holds the account that pushed the code is the person who has to agree to the licence terms for that code. So the line has to come from this account.

If the actual author of the work is Chandan and this account is just the one pushing, then the cleanest fix is for Chandan to open the PR from their own account and sign there. I will happily review it on the spot, the content is already good and I have done the count and wording fixes on the branch, so it is a matter of minutes.

Either way I am not able to merge it until the check goes green, and I would rather tell you now than leave the PR sitting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Multi-language README (de, zh, ja)

3 participants