Skip to content

Fix Japanese components documentation#2726

Merged
diemol merged 2 commits into
SeleniumHQ:trunkfrom
noritaka1166:fix/japanese-components-documentation
Jul 23, 2026
Merged

Fix Japanese components documentation#2726
diemol merged 2 commits into
SeleniumHQ:trunkfrom
noritaka1166:fix/japanese-components-documentation

Conversation

@noritaka1166

Copy link
Copy Markdown
Contributor

Description

Improve the Japanese translation of the Selenium components documentation.

  • Replace untranslated English text
  • Clarify descriptions of drivers, remote communication, and frameworks
  • Align terminology and headings with the English source page
  • Correct the Selenium Grid image alt text

Motivation and Context

The Japanese page contained untranslated text and several unclear or inaccurate translations.
This change makes the documentation easier to understand while preserving parity with the English source page.

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

@netlify

netlify Bot commented Jul 17, 2026

Copy link
Copy Markdown

Deploy Preview for selenium-dev ready!

Name Link
🔨 Latest commit 22485a0
🔍 Latest deploy log https://app.netlify.com/projects/selenium-dev/deploys/6a61d9fa6303590008ac3f94
😎 Deploy Preview https://deploy-preview-2726--selenium-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@qodo-code-review

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Improve Japanese translation for Components documentation

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Replace remaining English/untranslated text in the Japanese Components page.
• Clarify terminology and explanations for drivers, remote communication, and frameworks.
• Align headings and image alt text with the English source page.
Diagram

graph TD
  A["components.ja.md"] --> B["basic_comms.png"] --> C["remote_comms.png"] --> D["remote_comms_server.png"]
  A --> E["test_framework.png"]
Loading
High-Level Assessment

The approach is appropriate for a translation parity fix: update the Japanese page to match the English source terminology, headings, and figure alt text. Alternatives (e.g., partial translation or leaving legacy phrasing) would reduce consistency and reader clarity.

Files changed (1) +23 / -24

Documentation (1) +23 / -24
components.ja.mdRefine Japanese terminology and align Components page with English +23/-24

Refine Japanese terminology and align Components page with English

• Improves Japanese translations for key terms (API/library/driver/framework) and clarifies explanations of direct vs remote communication paths. Renames headings for better alignment with the English source and corrects the Selenium Grid figure alt text formatting/terminology.

website_and_docs/content/documentation/overview/components.ja.md

@qodo-code-review

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (1) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 10 rules

Grey Divider


Action required

1. .jar/.dll in prose 📘 Rule violation ⚙ Maintainability
Description
components.ja.md の一般説明文に、言語・バインディング固有のファイル拡張子(Java の .jar、.NET の
.dll)や、特定フレームワークを特定言語バインディングに結び付ける記述(.NET の NUnit、Java の JUnit、Ruby の
RSpec)が含まれています。これは、本文の説明は言語非依存に保ち、バインディング固有の情報は明確に分離された例/言語別セクションに限定するという要件に反します。
Code

website_and_docs/content/documentation/overview/components.ja.md[R18-19]

+* **ライブラリ:** APIと、それらを実装するために必要なコードを含むコードモジュール。
+ライブラリは言語バインディングごとに用意されています。たとえば、Java用の .jar ファイルや .NET用の .dll ファイルなどです。
Evidence
PR Compliance ID 2141345
では、ドキュメントの一般的な説明(規範的/記述的プローズ)を言語非依存にし、言語・バインディング固有の用語や詳細は明確に分離された例セクションにのみ記載することを求めています。該当箇所では、ライブラリ定義の説明文中で
Java用の .jar.NET用の .dll を明示し、さらに本文の説明内で NUnit/JUnit/RSpec をそれぞれ .NET/Java/Ruby
に結び付けているため、要件に反する「一般プローズ内のバインディング固有表現」であることが読み取れます。

Rule 2141345: Keep documentation prose language-agnostic, avoiding binding-specific terminology
website_and_docs/content/documentation/overview/components.ja.md[18-19]
website_and_docs/content/documentation/overview/components.ja.md[46-46]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`website_and_docs/content/documentation/overview/components.ja.md` の一般説明文に、言語・バインディング固有の成果物(`.jar`, `.dll`)や、テストフレームワークを特定の言語バインディングに紐づける記述(.NET の NUnit、Java の JUnit、Ruby の RSpec)が含まれており、言語非依存のプローズを維持するという要件に違反しています。一般説明は実装/言語に依存しない表現に書き換え、必要な場合のみ、明確に分離された例/言語別セクションへバインディング固有の情報を移動してください。

## Issue Context
PR Compliance ID 2141345 の方針として、本文の規範的・説明的な文章は言語非依存に保ち、言語/バインディング固有の用語・詳細は「明確にラベル付けされた例」または「言語別セクション」に限定する必要があります。今回の該当箇所は言語別の例としてラベル付けされていない一般説明文のため、(1) フレームワーク名や成果物をバインディングに結び付けずに列挙する、または (2) バインディング固有の対応関係を例/言語別セクションに移動する、といった形で整理してください。

## Fix Focus Areas
- website_and_docs/content/documentation/overview/components.ja.md[18-19]
- website_and_docs/content/documentation/overview/components.ja.md[46-46]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment thread website_and_docs/content/documentation/overview/components.ja.md
@qodo-code-review

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (2) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 10 rules

Grey Divider


Action required

1. .jar/.dll in prose 📘 Rule violation ⚙ Maintainability
Description
components.ja.md の一般説明文に、言語・バインディング固有のファイル拡張子(Java の .jar、.NET の
.dll)や、特定フレームワークを特定言語バインディングに結び付ける記述(.NET の NUnit、Java の JUnit、Ruby の
RSpec)が含まれています。これは、本文の説明は言語非依存に保ち、バインディング固有の情報は明確に分離された例/言語別セクションに限定するという要件に反します。
Code

website_and_docs/content/documentation/overview/components.ja.md[R18-19]

+* **ライブラリ:** APIと、それらを実装するために必要なコードを含むコードモジュール。
+ライブラリは言語バインディングごとに用意されています。たとえば、Java用の .jar ファイルや .NET用の .dll ファイルなどです。
Evidence
PR Compliance ID 2141345
では、ドキュメントの一般的な説明(規範的/記述的プローズ)を言語非依存にし、言語・バインディング固有の用語や詳細は明確に分離された例セクションにのみ記載することを求めています。該当箇所では、ライブラリ定義の説明文中で
Java用の .jar.NET用の .dll を明示し、さらに本文の説明内で NUnit/JUnit/RSpec をそれぞれ .NET/Java/Ruby
に結び付けているため、要件に反する「一般プローズ内のバインディング固有表現」であることが読み取れます。

Rule 2141345: Keep documentation prose language-agnostic, avoiding binding-specific terminology
website_and_docs/content/documentation/overview/components.ja.md[18-19]
website_and_docs/content/documentation/overview/components.ja.md[46-46]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`website_and_docs/content/documentation/overview/components.ja.md` の一般説明文に、言語・バインディング固有の成果物(`.jar`, `.dll`)や、テストフレームワークを特定の言語バインディングに紐づける記述(.NET の NUnit、Java の JUnit、Ruby の RSpec)が含まれており、言語非依存のプローズを維持するという要件に違反しています。一般説明は実装/言語に依存しない表現に書き換え、必要な場合のみ、明確に分離された例/言語別セクションへバインディング固有の情報を移動してください。

## Issue Context
PR Compliance ID 2141345 の方針として、本文の規範的・説明的な文章は言語非依存に保ち、言語/バインディング固有の用語・詳細は「明確にラベル付けされた例」または「言語別セクション」に限定する必要があります。今回の該当箇所は言語別の例としてラベル付けされていない一般説明文のため、(1) フレームワーク名や成果物をバインディングに結び付けずに列挙する、または (2) バインディング固有の対応関係を例/言語別セクションに移動する、といった形で整理してください。

## Fix Focus Areas
- website_and_docs/content/documentation/overview/components.ja.md[18-19]
- website_and_docs/content/documentation/overview/components.ja.md[46-46]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. Long prose lines in .ja.md 📘 Rule violation ✧ Quality ⭐ New
Description
Several modified lines in components.ja.md are far longer than the style guide’s ~100-character
line-length recommendation, making diffs and reviews harder to read. This contradicts the central
documentation style guide conventions.
Code

website_and_docs/content/documentation/overview/components.ja.md[R21-22]

+ほとんどのドライバーはブラウザベンダー自身によって作成されます。ドライバーは通常、ブラウザが稼働するシステム上で実行される実行可能モジュールであり、テストスイートを実行するシステムとは別のものです。(ただし、両者が同じシステムの場合もあります。)_注: ドライバーをプロキシと呼ぶ人もいます。_
+* **フレームワーク:** WebDriverスイートを補助するために使用する追加ライブラリ。これらのフレームワークは、JUnitやNUnitなどのテストフレームワークである場合があります。また、CucumberやRobot Frameworkといった自然言語の機能をサポートするフレームワークである場合もあります。テスト対象システムの操作や構成、データ作成、テストオラクルなどのために、フレームワークを作成して使用することもあります。
Evidence
The style guide recommends limiting documentation source line length to ~100 characters. The
modified prose in components.ja.md includes very long single lines (e.g., the driver/framework
descriptions), which conflicts with that guidance.

Rule 2141344: Documentation changes must follow the central style guide file
website_and_docs/content/documentation/about/style.en.md[40-44]
website_and_docs/content/documentation/overview/components.ja.md[21-22]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The updated Japanese documentation contains very long single-line paragraphs that exceed the style guide’s recommended line length, reducing readability in diffs/reviews.

## Issue Context
The central style guide recommends keeping documentation source lines to around 100 characters.

## Fix Focus Areas
- website_and_docs/content/documentation/overview/components.ja.md[21-22]
- website_and_docs/content/documentation/about/style.en.md[40-44]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Previous review results

Review updated until commit 22485a0 ⚖️ Balanced

Results up to commit 1ef0b55


🐞 Bugs (0) 📘 Rule violations (1) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)


Action required
1. .jar/.dll in prose 📘 Rule violation ⚙ Maintainability
Description
components.ja.md の一般説明文に、言語・バインディング固有のファイル拡張子(Java の .jar、.NET の
.dll)や、特定フレームワークを特定言語バインディングに結び付ける記述(.NET の NUnit、Java の JUnit、Ruby の
RSpec)が含まれています。これは、本文の説明は言語非依存に保ち、バインディング固有の情報は明確に分離された例/言語別セクションに限定するという要件に反します。
Code

website_and_docs/content/documentation/overview/components.ja.md[R18-19]

+* **ライブラリ:** APIと、それらを実装するために必要なコードを含むコードモジュール。
+ライブラリは言語バインディングごとに用意されています。たとえば、Java用の .jar ファイルや .NET用の .dll ファイルなどです。
Evidence
PR Compliance ID 2141345
では、ドキュメントの一般的な説明(規範的/記述的プローズ)を言語非依存にし、言語・バインディング固有の用語や詳細は明確に分離された例セクションにのみ記載することを求めています。該当箇所では、ライブラリ定義の説明文中で
Java用の .jar.NET用の .dll を明示し、さらに本文の説明内で NUnit/JUnit/RSpec をそれぞれ .NET/Java/Ruby
に結び付けているため、要件に反する「一般プローズ内のバインディング固有表現」であることが読み取れます。

Rule 2141345: Keep documentation prose language-agnostic, avoiding binding-specific terminology
website_and_docs/content/documentation/overview/components.ja.md[18-19]
website_and_docs/content/documentation/overview/components.ja.md[46-46]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`website_and_docs/content/documentation/overview/components.ja.md` の一般説明文に、言語・バインディング固有の成果物(`.jar`, `.dll`)や、テストフレームワークを特定の言語バインディングに紐づける記述(.NET の NUnit、Java の JUnit、Ruby の RSpec)が含まれており、言語非依存のプローズを維持するという要件に違反しています。一般説明は実装/言語に依存しない表現に書き換え、必要な場合のみ、明確に分離された例/言語別セクションへバインディング固有の情報を移動してください。

## Issue Context
PR Compliance ID 2141345 の方針として、本文の規範的・説明的な文章は言語非依存に保ち、言語/バインディング固有の用語・詳細は「明確にラベル付けされた例」または「言語別セクション」に限定する必要があります。今回の該当箇所は言語別の例としてラベル付けされていない一般説明文のため、(1) フレームワーク名や成果物をバインディングに結び付けずに列挙する、または (2) バインディング固有の対応関係を例/言語別セクションに移動する、といった形で整理してください。

## Fix Focus Areas
- website_and_docs/content/documentation/overview/components.ja.md[18-19]
- website_and_docs/content/documentation/overview/components.ja.md[46-46]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Qodo Logo

Comment thread website_and_docs/content/documentation/overview/components.ja.md
@diemol
diemol merged commit 6204064 into SeleniumHQ:trunk Jul 23, 2026
6 checks passed
@noritaka1166
noritaka1166 deleted the fix/japanese-components-documentation branch July 23, 2026 09:44
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.

2 participants