docs: update FAQs with recent issues#686
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Astron RPA FAQ documentation by incorporating solutions to recently encountered issues and common user questions. The updates aim to provide clearer guidance on installation, client usage, advanced feature implementation, and troubleshooting, thereby improving the overall user experience and reducing support inquiries. Both English and Chinese versions of the FAQ have been synchronized with these comprehensive additions. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
FenjuFu seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly expands the FAQ documentation in both English and Chinese versions. It introduces new sections and answers covering a wide range of topics, including client installation and connection issues, web automation challenges (like element capturing and lazy-loading dropdowns), workflow parameter handling, dependency management for Python libraries, intranet usage, virtual desktop troubleshooting, and various other common problems and solutions. The review comments suggest minor improvements to grammar, clarity, and technical terminology in both language versions to enhance the overall quality and readability of the documentation.
|
|
||
| ### Q: 🆕 Is it normal for the server atlas container to exit automatically after starting? | ||
|
|
||
| **A:** ✅ **Normal!** The Atlas container is used for database Schema migration and will automatically exit upon task completion. As long as the log shows "Schema is synced", it means success. |
There was a problem hiding this comment.
For grammatical correctness and consistency, "Schema" should be lowercase when used as a common noun.
| **A:** ✅ **Normal!** The Atlas container is used for database Schema migration and will automatically exit upon task completion. As long as the log shows "Schema is synced", it means success. | |
| **A:** ✅ **Normal!** The Atlas container is used for database schema migration and will automatically exit upon task completion. As long as the log shows "Schema is synced", it means success. |
|
|
||
| ### Q: 🆕 Is there any difference between the open-source version and the enterprise version of RPA? | ||
|
|
||
| **A:** The open-source version of the RPA client is universal with the platform version, but you need to pay attention to configuring the corresponding server address. |
There was a problem hiding this comment.
The phrase "is universal with the platform version" is slightly unclear. For better readability, I suggest rephrasing to explicitly state compatibility.
| **A:** The open-source version of the RPA client is universal with the platform version, but you need to pay attention to configuring the corresponding server address. | |
| **A:** The open-source version of the RPA client is compatible with the platform version, but you need to ensure it is configured with the corresponding server address. |
| For "lazy loading" drop-down menus where the rendered options exceed a certain number (e.g., 200), but the actual HTML only renders a few within the viewport (e.g., 10), normal capturing will fail when scrolling. | ||
| **Solutions:** | ||
| 1. **Keyboard Simulation:** Use "Simulate Keystrokes" (such as the down arrow `Down`) to select options one by one. | ||
| 2. **XPath Customization:** If the element exists in the DOM although invisible, try getting it via customized XPath. |
There was a problem hiding this comment.
The phrasing "although invisible" is slightly awkward. Using "but is not visible" would sound more natural in English.
| 2. **XPath Customization:** If the element exists in the DOM although invisible, try getting it via customized XPath. | |
| 2. **XPath Customization:** If the element exists in the DOM but is not visible, try getting it via a customized XPath. |
|
|
||
| **A:** | ||
|
|
||
| - **Input parameters:** Define "Process Parameters" in the RPA workflow design, and pass the corresponding Key-Value when calling externally. |
There was a problem hiding this comment.
The term "Key-Value" is unconventional. The standard technical term is "key-value pairs", which would be clearer for users.
| - **Input parameters:** Define "Process Parameters" in the RPA workflow design, and pass the corresponding Key-Value when calling externally. | |
| - **Input parameters:** Define "Process Parameters" in the RPA workflow design, and pass the corresponding key-value pairs when calling externally. |
|
|
||
| **A:** | ||
|
|
||
| It may be missing `Microsoft Edge WebView2 Runtime` or the version is too low (common in older systems or cloud desktops). Please try updating WebView2 Runtime. |
There was a problem hiding this comment.
The current phrasing is a bit informal. Rephrasing the sentence can improve its clarity and professional tone.
| It may be missing `Microsoft Edge WebView2 Runtime` or the version is too low (common in older systems or cloud desktops). Please try updating WebView2 Runtime. | |
| This may be caused by a missing or outdated version of `Microsoft Edge WebView2 Runtime` (common in older systems or cloud desktops). Please try updating it. |
|
|
||
| **A:** | ||
|
|
||
| If a crash or complete failure occurs when capturing elements, it may be because other applications running in the system (such as the "Doubao" client) are also trying to take over the browser environment, causing a dual conflict. |
There was a problem hiding this comment.
The term "dual conflict" is redundant. Simply using "conflict" is more concise. Additionally, rephrasing "take over the browser environment" to be more neutral could improve clarity.
| If a crash or complete failure occurs when capturing elements, it may be because other applications running in the system (such as the "Doubao" client) are also trying to take over the browser environment, causing a dual conflict. | |
| If a crash or complete failure occurs when capturing elements, it may be because another application running on the system (such as the "Doubao" client) is also trying to control the browser, causing a conflict. |
|
|
||
| ### Q: 🆕 开源版与企业版 RPA 有区别吗？ | ||
|
|
||
| **A:** 开源版 RPA 客户端与平台版通用，但需注意配置对应的服务端地址。 |
There was a problem hiding this comment.
The term 通用 (universal/common) is a bit ambiguous in this context. To improve clarity for Chinese readers, consider rephrasing to explicitly state compatibility, for example, by using 兼容 (compatible).
| **A:** 开源版 RPA 客户端与平台版通用，但需注意配置对应的服务端地址。 | |
| **A:** 开源版 RPA 客户端与平台版兼容，但需注意配置对应的服务端地址。 |
|
|
||
| **A:** | ||
|
|
||
| - **入参：** 在 RPA 流程设计中定义“流程参数”，外部调用时传入对应 Key-Value。 |
There was a problem hiding this comment.
While Key-Value is often understood in Chinese technical contexts, using the standard term 键值对 would be more formal and precise for better documentation quality.
| - **入参：** 在 RPA 流程设计中定义“流程参数”，外部调用时传入对应 Key-Value。 | |
| - **入参：** 在 RPA 流程设计中定义“流程参数”，外部调用时传入对应的键值对 (Key-Value)。 |
|
|
||
| **A:** | ||
|
|
||
| 如果在拾取元素时发生闪退或完全失效，可能是由于系统中运行的其他应用（例如“豆包”客户端）也尝试接管浏览器环境，造成双重冲突。 |
There was a problem hiding this comment.
The term 双重冲突 (dual conflict) is redundant. Simply using 冲突 (conflict) is more concise and clear.
| 如果在拾取元素时发生闪退或完全失效，可能是由于系统中运行的其他应用（例如“豆包”客户端）也尝试接管浏览器环境，造成双重冲突。 | |
| 如果在拾取元素时发生闪退或完全失效，可能是由于系统中运行的其他应用（例如“豆包”客户端）也尝试接管浏览器环境，造成了冲突。 |
Co-authored-by: FenjuFu <fenjufu@example.com>
3 participants
This PR updates the
FAQ.zh.mdandFAQ.mddocuments with recent common questions and troubleshooting steps.It directly resolves #685.
Changes include:
The English documentation
FAQ.mdhas also been translated and synced with the new changes.