Add WasmEdge Style Guide

[mhmohona]

Explanation

This PR introduces a new file, STYLE_GUIDE.md, to the WasmEdge repository. This file contains two style guides: one for documentation and one for coding.

Related issue

#85

What type of PR is this

/kind documentation

Proposed Changes

[alabulei1]

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

---

Overall, the patches reviewed in this Pull Request seem to be straightforward additions and improvements to the documentation. There are no significant issues or errors identified in any of the patches. The changes include the addition of a new FAQ page, the inclusion of a style guide, hyperlink additions and revisions, and minor wording changes. The patches aim to enhance the clarity, accuracy, and usability of the documentation for users.

The most important findings include the addition of a style guide, which will help maintain consistency in coding and documentation practices. The inclusion of hyperlinks to external resources and the revision of sentences for clarity further improve the quality of the FAQ page.

However, there are a few minor suggestions for improvement. Firstly, in one of the patches, the Signed-off-by field should contain a valid email address associated with the author's GitHub account. Secondly, the commit message in another patch could be more precise and mention the specific file(s) being updated. Additionally, there is a link to the Discord server that needs to be updated to the correct URL. Lastly, in one patch, the URL format for the hyperlinks is incorrect, and it should be corrected to avoid broken links.

In summary, the changes made in this Pull Request overall enhance the documentation and provide valuable resources for users. With some minor improvements and corrections, these patches can be merged into the codebase without any major issues.

Details

Commit 6a5c4a884bae8bb4e4587aca8bbe3bdb44d1e2c3

Key changes:

• Added a new FAQ page in both English and Chinese versions.
• The FAQ page provides answers to common technical inquiries about WasmEdge.
• Each question is numbered and followed by a detailed answer.
• The FAQ page also includes a reminder to refer to the comprehensive documentation and reach out to the WasmEdge community for assistance.

Potential problems:

• No potential problems are identified in this patch. It seems to be a straightforward addition of the FAQ page to the documentation.

Commit 8d2036363f8188b6f2d46b53cb5d1754ab375db1

Key changes:

• Added a new file STYLE_GUIDE.md.
• Added a documentation style guide section.
• Added a coding style guide section.

Potential problems:

• No major issues found in the changes made.

Overall, the changes look good. The addition of a style guide for documentation and coding will help ensure consistency and improve the quality of the project's code and documentation.

Commit 919948ef1d383f839cbfc7c0d8ee537490a277e8

Key changes in the patch:

• Added hyperlinks to the WasmEdge documentation and community resources.
• Revised some sentences for clarity.

Potential problems:

• No significant problems were identified in this patch.

Overall, the changes made in this patch improve the FAQ page by adding relevant hyperlinks to external resources. The revisions to the sentences also enhance the clarity of the content.

Commit a9ee642acc2db71944cc6311452bf99c0d4800c1

Key changes:

• Updated the FAQ page in the zh language version of the documentation
• Added links to the WasmEdge documentation and Discord server
• Minor changes in the wording of some answers

Potential problems:

• The email address in the Signed-off-by field should be a valid email address associated with the author's GitHub account.
• There is no mention of updating any other file in the commit message, so the commit message may be misleading.
• The link to the Discord server should be updated to the correct URL.

Overall, the changes seem to be improvements to the FAQ page, providing more accurate information and additional resources for users.

Commit d514133d59b37a2816065bd273762b18e3758f7e

The key change in this patch is a fix to a hyperlink in the file docs/develop/getting-started/faq.md. The original hyperlink was missing a forward slash, which caused it to navigate incorrectly.

Potential problems with this patch are:

1. The patch only fixes a single hyperlink. It would be more efficient to combine multiple small fixes into a single patch. This would reduce the overhead of creating and reviewing multiple patches.

2. The patch includes changes to both the English and Chinese versions of the file faq.md. It would be better to separate these changes and create separate patches for each language.

Overall, the changes in this patch appear to be straightforward and should not introduce any significant problems.

Commit 7cbf126a9ea0fe3ddce20f281cafcddff4bcd7d2

Key changes:

• The patch fixes a hyperlink in the FAQ section of the documentation.
• The patch updates the hyperlink to point to the correct location.

Potential problems:

• There doesn't appear to be any potential problems with this change.

Commit 79fe907884ba4a71f575c5275f0bc5ffb16f4d3a

Key changes:

• The patch updates the hyperlink format in two files: docs/develop/getting-started/faq.md and i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started/faq.md.
• The patch changes the hyperlink ../contribute/plugin/test_plugin.md to ..../contribute/plugin/test_plugin.md in both files.

Potential problems:

• The updated hyperlink format in both files is incorrect. It adds extra dots before the slash, resulting in an invalid URL.
• The incorrect hyperlink format could lead to broken links when accessing the documentation.

Suggested improvement:
The hyperlink format should be corrected to ensure valid URLs and avoid broken links.

Commit c4e3910c110325667600d9ba995930fe1e71e677

Key Changes:

• The patch updates two hyperlinks in the faq.md file.
• The hyperlinks are fixed to point to the correct locations.

Potential Problems:

• There don't appear to be any potential problems with this patch. It is a simple fix to update incorrect hyperlinks.

Overall, this patch seems to be straightforward and doesn't introduce any new issues. It can be considered for merging into the codebase.

Commit 09bfb4bd2bd5e27045d6254b20c687c8c061eaef

Key changes:

• The patch updates two instances of a hyperlink in the FAQ section of the getting-started documentation.
• The hyperlink URLs are changed from relative paths to absolute URLs.

Potential problems:

• None of the changes in this patch seem to introduce any problems. The changes are straightforward and do not impact the functionality or readability of the codebase.
• The URLs provided in the hyperlinks appear to be correct and accessible.

Overall, this patch seems fine and can be merged without any issues.

Commit e83f6f79efdb1d03c2e263ef8dad86ab451319b6

Key changes:

• Added a hyperlink to the phrase "model inference" in the FAQ section.

Potential problems:

• No potential problems found in this patch.

[alabulei1]

Link an article for AI/LLM inference.

[mhmohona]

Could you please provide the link of that article? I am confused which one should i add.

[alabulei1]

https://www.secondstate.io/articles/fast-llm-inference/

[alabulei1]

Add a link for tensorflow inference

[alabulei1]

Link a doc for this function.

[alabulei1]

What do you mean by backend?

[alabulei1]

Hi @mhmohona

Please check out my comments. Thanks. BTW, how did you find these issues?

[mhmohona]

@alabulei1 so here are the source, I had these questions while writing the plugin doc. ALso i went through the discussion to find the general questions about plugin.