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

Add troubleshooting guide #192

Merged
merged 2 commits into from Jan 2, 2024
Merged

Conversation

mhmohona
Copy link
Contributor

@mhmohona mhmohona commented Nov 8, 2023

Explanation

Added troubleshooting guide for wasmedge

Related issue

What type of PR is this

/kind documentation

Proposed Changes

Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>
Copy link
Collaborator

alabulei1 commented Nov 8, 2023

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


Overall Summary:

This pull request adds a new troubleshooting guide for WasmEdge in two languages and includes links to relevant documentation and resources. It also adds hyperlinks to the AOT compiler, contribution guidelines, and updates the hyperlink to the WasmEdge codebase.

Potential issues and errors:

  • The troubleshooting guide lacks specific examples and real-life scenarios, which may reduce its practicality and usefulness for users.
  • The guide could benefit from providing more detailed solutions and step-by-step instructions for troubleshooting.
  • There is no newline at the end of the file in both the English and Chinese versions.

Most important findings:

  • The addition of the troubleshooting guide is a valuable resource for users.
  • The inclusion of hyperlinks to relevant documentation and resources enhances the guide's usefulness.
  • The updates to hyperlinks improve the overall user experience.

Overall, this pull request is a positive addition to the project but could be further enhanced by addressing the potential issues and errors mentioned above.

Details

Commit 236bd2f0ed24409fd65fdc2c4ad6c85d56e1c044

Key changes in the patch:

  • Added a new troubleshooting guide for WasmEdge in two languages (English and Chinese).
  • The troubleshooting guide covers various topics such as installation issues, runtime errors, performance issues, and contributing to WasmEdge.
  • Included links to relevant documentation and resources for further assistance.

Potential problems to note:

  • The troubleshooting guide does not include any specific examples or real-life scenarios, which could make it less practical and less helpful for users.
  • The guide could benefit from providing more detailed solutions and step-by-step instructions for troubleshooting.
  • There is no newline at the end of the file in both English and Chinese versions.

Commit d2332b0966af180d17998e79e86806f0eab594ea

Key changes:

  • Added hyperlinks to the AOT compiler and contribution guidelines.
  • Updated the hyperlink to the WasmEdge codebase.

Potential problems:

  • There don't seem to be any potential problems in this patch. The changes appear to be straightforward and improve the troubleshooting guide by adding helpful hyperlinks.

Copy link
Contributor

@adithyaakrishna adithyaakrishna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file name seems to be a bit too large, especially considering if we share the links in the future. How abt we rename it to troubleshoot?


## Contributing to WasmEdge

If you're having trouble contributing to WasmEdge, make sure to:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link to our contribution guide.


If you're having trouble contributing to WasmEdge, make sure to:

1. **Follow the Contribution Guidelines**: Ensure that your contributions follow the guidelines provided in the WasmEdge repository.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link to our code.


If WasmEdge is running slowly or consuming too much memory, consider the following:

1. **Optimization**: Make sure you're using the AOT compiler if performance is a concern. The AOT compiler can significantly speed up the execution of Wasm files.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the docs about how to use AoT compiler.

Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>
@alabulei1 alabulei1 merged commit 8ef708b into WasmEdge:main Jan 2, 2024
6 checks passed
kelvinparmar pushed a commit to kelvinparmar/docs that referenced this pull request Feb 3, 2024
* Troubleshooting Guide

Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>

* add hy;erlink

Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>

---------

Signed-off-by: Mahfuza Humayra Mohona <mhmohona@gmail.com>
Signed-off-by: kelvin <pkelvin123456789@gmail.com>
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.

None yet

3 participants