Closed mhmohona closed 1 year ago
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 aims to update the loadable plugin section of the documentation by providing information on creating and loading plugins in the WasmEdge runtime environment. The key changes include adding explanations on creating loadable plugins, providing example code, and introducing a flowchart to illustrate the plugin loading process.
The potential issues and errors identified include the lack of explicit error handling in the example code for loading plugins and the need for more detailed explanations in the flowchart. It is important to mention the possibility of handling loading failures and improve the flowchart to cover alternative paths and error handling scenarios.
In terms of importance, ensuring proper error handling and clear flowchart explanations are crucial. These improvements will enhance the user experience and understanding of the plugin loading process.
Additionally, it's advisable to check if the flowchart renders correctly in the intended platform before merging the pull request. Furthermore, it is also recommended to review whether the code implementation was modified correctly and adequately, as the changes seem to be related to documentation formatting.
Overall, this pull request brings valuable updates to the loadable plugin section, with potential improvements to error handling and flowchart explanations.
Key changes:
Potential problems:
Key Changes:
Potential Problems:
intro.md
file is displayed using the Mermaid syntax, which may not be rendered properly in all documentation platforms or text editors. It would be best to check if the flowchart renders correctly in the intended platform before merging this pull request.Key Changes:
intro.md
has been updated.Potential Problems:
Key Changes:
Potential Problems:
@alabulei1 CI Workflows need your approval to run. Its a default feature of GH Actions. More Info: https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks
@mhmohona Lint check failing here 👀
@adithyaakrishna yes, its the same error I am getting all my PRs. I am unable to fix it. :3
@mhmohona There seems to be linting issues in many files which were not changed, I have created a PR #109 to fix the CI and linting issues :)
Hi @mhmohona
Still have one CI that didn't pass. Could you fix again?
@alabulei1 I hope cli check will pass now.
@alabulei1 The workflows need to be approved manually for it to run 😶
@mhmohona The lint CI passed! But the DCO tests failed. Could you please take a look again? Thanks.
Explanation
Update Loadable Plug-in section - expanded explanation and added flowchart for better understanding of the workflow. Also updated as per Yi-Ying's review.
Reopening PR https://github.com/WasmEdge/docs/pull/86 for passing DOC test
Related issue:
What type of PR is this
/kind documentation
Proposed Changes