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

[Doc] update docs #50

Merged
merged 4 commits into from
Aug 4, 2023
Merged

[Doc] update docs #50

merged 4 commits into from
Aug 4, 2023

Conversation

apepkuss
Copy link
Collaborator

@apepkuss apepkuss commented Aug 4, 2023

Update the docs for the next release.

Copy link
Member

juntao commented Aug 4, 2023

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


Overall, the pull request includes a mix of changes. Here are the potential issues and most important findings:

  1. The disabling of build and deployment of the Async API documentation lacks explanation. It would be helpful to include a comment clarifying the rationale and status of the feature.
  2. The version update of wasmedge-sys crate to 0.16.1 does not raise any potential problems.
  3. The addition of a new row to a table in the lib.rs file seems minimal and lacks context. It may be worth discussing the purpose and impact of this change further with the author.
  4. Updates to the README.md and src/lib.rs files include adding a table with version dependencies and providing additional information about the location search order and standalone feature. No potential problems were identified with these changes.

Considering all the individual changes, the pull request appears to mainly focus on documentation updates. Potential issues include the lack of explanation for disabling the build and deployment of the Async API documentation and the need for further clarification on the purpose of some changes.

Details

Commit d689486abf70773b1da5b86a4720160e39761746

Key changes:

  • The patch disables the build and deployment of the Async API documentation for the Wasmedge Rust SDK.

Potential problems:

  • The patch disables the build and deployment of the Async API documentation without providing any explanation or rationale. It would be helpful to include a comment explaining why this change is being made.
  • The commented-out code for building and deploying the Async API documentation suggests that this feature may be incomplete or not functioning properly. It would be beneficial to address this issue or provide an update on the status of the feature.

Note: Without more context or information, it is difficult to provide a comprehensive analysis of the patch.

Commit 6350600ef14e25126f15a3314cd37a49018ec950

Key changes:

  • Update the version of wasmedge-sys crate to 0.16.1.

Potential problems:

  • None identified.

Overall, this patch updates the version of the wasmedge-sys crate to 0.16.1. No potential problems were identified in this patch.

Commit 8a3b8044146e707c3bcdc467766255b0356097e1

Key changes:

  • Added a new row to a table in the lib.rs file, specifying version numbers for different dependencies.

Potential problems:

  • No potential problems identified in this patch.
  • However, the changes made are quite minimal and do not seem to address any actual code changes or documentation updates. It may be worth discussing with the author the purpose and impact of this change.

Commit f87f8a564782a923a1f45da99874ca0c828fa64c

Key changes:

  • The README.md file and the src/lib.rs file have been updated.
  • A table in the README.md file was added with version dependencies for different crates.
  • The src/lib.rs file was updated with additional information about the location search order for the WasmEdge library, and support for the standalone feature.

Potential problems:

  • None of the changes appear to introduce any potential problems. The changes seem to be purely informational updates to the documentation.

@apepkuss
Copy link
Collaborator Author

apepkuss commented Aug 4, 2023

@L-jasmine Could you please help review this PR? Thanks a lot!

@apepkuss apepkuss requested a review from L-jasmine August 4, 2023 09:16
@apepkuss
Copy link
Collaborator Author

apepkuss commented Aug 4, 2023

@L-jasmine Thanks for the review!

@apepkuss apepkuss merged commit e5df06a into WasmEdge:main Aug 4, 2023
16 of 19 checks passed
@apepkuss apepkuss deleted the doc/update-docs branch August 4, 2023 11:16
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.

3 participants