docs: Add Japanese README

[gemmaro]

📑 Summary

This adds a Japanese translation of the readme and links to it.

There are no related issues.

📏 Design Decisions

This doesn't change implementation; document additions only.

The translation has been done with reference to the prior work of @NurseAngel as in README.ja-JP.md, although there are many changes.

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added necessary unit/e2e tests. (Skipped since there is no implementation change)
• 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
• 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:. (Checked that this is not the case)

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	e24cb57
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/67485d33b81d1b00084c5de3
😎 Deploy Preview	https://deploy-preview-6065--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6065

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6065

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6065

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6065

commit: e24cb57

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 4.48%. Comparing base (df636c6) to head (e24cb57).

Additional details and impacted files

@@           Coverage Diff           @@
##           develop   #6065   +/-   ##
=======================================
  Coverage     4.48%   4.48%           
=======================================
  Files          383     383           
  Lines        54038   54038           
  Branches       596     596           
=======================================
  Hits          2425    2425           
  Misses       51613   51613           

Flag	Coverage Δ
unit	4.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[sidharthv96]

I don't feel comfortable adding a new language, when it'll be outdated soon, as we don't have enough bandwidth to maintain the translations. Moreover, we have our docs in English only.

Similar PR #4888

[gemmaro]

Thank you for checking and letting me know about the pull request for Hindi. I respect your take on this.

I think there are three sustainable approaches.

1. Introducing po4a (or other tools)
2. Add links to translations
3. Do not add translations nor links to them

Option 1:

I'd like to propose the introduction of po4a, a translation maintenance tool based on gettext. It helps to automatically update the translations according to the original English texts, and to untranslate parts of them when they become outdated.
I actually used it to do this translation, and can provide the gettext PO file and scripts to update it.

Option 2, 3:

If there are links to the translations, it will be easier to find them without much searching. Of course, it is possible for the link destination to be out of date or for the link to break.

[sidharthv96]

Thanks for the suggestion. If we're using machine translation like po4a, how much better would it be, than the browser's native translation feature?
I'm assuming someone who is not comfortable in English, would already have some kind of translation extension enabled.

[gemmaro]

Thank you for your reply!

I'd like to make it clear that po4a is not a machine translation tool; rather, it facilitates the manual translation process.

Manual translation allows for a deeper understanding of the text, capturing nuances, idioms, and markups. While browser-native translation features can be helpful, they often lack the precision and quality that a manual approach provides. Even if someone has a translation extension, the effectiveness of the translation can vary, and having a dedicated manual process can significantly improve clarity and communication.

In this pull request it is just the readme, but there is a lot of documentation available for Mermaid. I think it would be wonderful to be able to read this document fluently translated into different languages.

[sidharthv96]

@gemmaro do you mind adding the po4a files so we can get a better understanding of the process?
If it's manual translation, we're again back to the issue of not having enough bandwidth/knowledge of other languages.
If it's semi automated, I'd like to see how much extra complexity it adds for documentation. (Our documentation is not perfect, and extra friction for adding documentation has a risk of bringing down the quantity).

[changeset-bot]

⚠️ No Changeset found

Latest commit: e24cb57

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[gemmaro]

@sidharthv96 I have added po4a files to the commit "docs: Add the translation update script and configs".
To update the translation, please run ./scripts/translation.bash.

These files do not get in the way of writing original documentation. They don't require any special markup in the source documents or additional configuration.