search

SeleniumHQ / seleniumhq.github.io

Official Selenium website and documentation
https://selenium.dev
Apache License 2.0
1.03k stars 1.23k forks source link

feature/safari_20240701 #1791

Closed alaahong closed 2 weeks ago

alaahong commented 2 weeks ago

User description

Thanks for contributing to the Selenium site and documentation! A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines. Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Motivation and Context

Types of changes

Checklist

PR Type

Documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
safari.zh-cn.md
Improve Chinese translation and update Safari documentation
website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md
  • Improved translation for better clarity and consistency.
  • Changed section titles from English to Chinese.
  • Updated references to the Appium project and service settings.
  • Enhanced logging instructions and added notes for Java.
    		•  +15/-11 

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    netlify[bot] commented 2 weeks ago

    Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    Latest commit eec59e261b1a6cbe0ba8deaaa962704751707279
    codiumai-pr-agent-pro[bot] commented 2 weeks ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 2
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review Translation Consistency:
    Ensure that the translations are consistent with the terminology used throughout the rest of the documentation.
    Link Verification:
    Verify that the updated links (e.g., to the Appium project) are accessible and correct.
    codiumai-pr-agent-pro[bot] commented 2 weeks ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Maintain the original product names in English to ensure clarity and consistency ___ **The translation of "Safari Technology Preview" to "Apple 提供了其浏览器的开发版本" changes the meaning
    slightly. It's better to keep the product name in English to maintain clarity and
    consistency, especially for technical terms.** [website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md [94]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1791/files#diff-a7937d029700732a1a80db8aaab9b545b2a5e14015ff3875aedc43f4a239aca8R94-R94) ```diff +Apple 提供了其浏览器的开发版本 — [Safari Technology Preview](https://developer.apple.com/safari/technology-preview/) - ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: Keeping technical terms and product names in their original language ensures clarity and consistency, which is crucial for technical documentation. This suggestion addresses a best practice for multilingual documentation.
    		9
    Enhancement
    Use HTML tags for line breaks in Markdown to ensure proper rendering ___ **The new text introduces a line break using a backslash, which is not standard in Markdown
    and might not render as expected. Consider using HTML tags for line breaks if necessary.** [website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md [69-71]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1791/files#diff-a7937d029700732a1a80db8aaab9b545b2a5e14015ff3875aedc43f4a239aca8R69-R71) ```diff -**注意**: Java也允许使用环境变量进行设置;\ -属性键: `SafariDriverService.SAFARI_DRIVER_LOGGING`\ +**注意**: Java也允许使用环境变量进行设置;
    +属性键: `SafariDriverService.SAFARI_DRIVER_LOGGING`
    属性值: `"true"` 或 `"false"` ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: Using HTML tags for line breaks ensures proper rendering across different Markdown processors, which is important for documentation readability and presentation.
    		8
    Maintainability
    Ensure consistent terminology for external links and references ___ **Consider using consistent terminology for links and references to external resources. The
    original text used "Appium project" and the new text uses "Appium 项目". It would be better
    to keep the terminology consistent across the document to avoid confusion.** [website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md [50]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1791/files#diff-a7937d029700732a1a80db8aaab9b545b2a5e14015ff3875aedc43f4a239aca8R50-R50) ```diff -那些希望在iOS上自动化Safari的人可以参考 [Appium 项目](//appium.io/). +那些希望在iOS上自动化Safari的人可以参考 [Appium project](//appium.io/). ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Consistent terminology helps avoid confusion and maintains readability, especially in translated documents. However, this is a minor maintainability issue rather than a critical one.
    		7