Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install.md #184

Merged
merged 3 commits into from
Nov 2, 2023
Merged

Conversation

ezirmusitua
Copy link
Contributor

Explanation

Add zh-cn translation

Related issue

N/A

What type of PR is this

/kind documentation

Proposed Changes

Translate i18n/zh/docusaurus-plugin-content-docs/current/start/install.md

Copy link
Collaborator

alabulei1 commented Oct 31, 2023

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Overall, the patch for updating the "install.md" file seems to have some potential issues and errors that should be addressed.

Firstly, the patch only translates the content into Chinese without updating the English version. This means that the English version will become outdated if the changes from the patch are merged. It would be ideal to have both versions updated to ensure consistency.

Secondly, the addition of the "{{ wasmedge_version }}" placeholder in the command example is unclear. The purpose or intent of this placeholder should be clarified or removed if unnecessary.

Thirdly, the link added in the note section is not functional in the diff. It should be fixed to point to the correct location within the repository.

Lastly, the inclusion of the merge commit message in the diff does not seem necessary and should be removed from the patch.

Overall, the patch has some potential issues that need to be addressed. Once these issues are resolved, the patch's changes can improve the Chinese translation of the "install.md" file and update related command examples and explanations.

Details

Commit ae2e454da1a019872b2034d676f9f41db014aafd

Key changes in the patch:

  • The patch updates the "Install and uninstall WasmEdge" section in the "install.md" file.
  • The patch translates the original English content into Chinese.
  • The patch updates the command examples and adds explanations in Chinese.
  • The patch updates the note section by adding a link to a related document.

Potential problems:

  • The patch only translates the content into Chinese without updating the English content, which means the English version will become outdated.
  • It is unclear why the patch adds the "{{ wasmedge_version }}" placeholder in the command example. This needs clarification or removal.
  • The patch adds a link to a related document in the note section, but the link is not functional in the diff. It should be fixed to point to the correct location.
  • It is unclear why the patch includes the merge commit message in the diff, and it should be removed.

Commit 8e3076d962d0662bb74434814d3f9c33da5103b4

The key change in this patch is an update to the install.md file in the start directory of the Chinese (zh) translation of the documentation. Specifically, the change is in the note section within the file. The URL link has been corrected from https://chat.openai.com/c/build-and-run/docker_wasm.md to build-and-run/docker_wasm.md. This fix ensures that the link points to the correct location within the repository.

There don't seem to be any potential problems with this patch. It is a simple fix that resolves an incorrect URL.

Commit f9b5dffafbee804b151498f74aba59dfea64e4fb

Key changes:

  • Updated Chinese translation in the file install.md under the start directory.
  • Replaced "执行" with "运行" to translate "execute".
  • Changed "将" to "使用" to translate "compile".
  • Updated the file extension translation for the output files to be more platform-specific.

Potential problems:

  • The translation for "execute" has been changed to "运行", which might not accurately convey the meaning in the context of executing a WASM file. It is recommended to check with a Chinese language expert or a native speaker familiar with the subject matter to ensure the accuracy of the translation.
  • The translation for "compile" has been changed to "使用", which might not accurately convey the meaning of the process. It is recommended to check with a Chinese language expert or a native speaker familiar with the subject matter to ensure the accuracy of the translation.
  • The comment at the end of the file, :::note, is not fully rendered and might need further adjustments.

Overall, the changes seem to improve the Chinese translation of the install.md file.

@alabulei1
Copy link
Collaborator

Hi @ezirmusitua

Please check out my comments. Thanks

Signed-off-by: ezirmusitua <jferroal@gmail.com>
Signed-off-by: ezirmusitua <jferroal@gmail.com>
Signed-off-by: ezirmusitua <jferroal@gmail.com>
@alabulei1 alabulei1 merged commit 015bdbc into WasmEdge:main Nov 2, 2023
6 checks passed
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