Add faq page and style guide

[mhmohona]

Explanation

Added faq page for Wasmedge

Related issue

37

Continuation of PR #198

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.

---

Summary:

The overall summary for the GitHub Pull Request titled "Add faq page and style guide" is as follows:

Potential Issues and Errors:

• The patch introduces a new file STYLE_GUIDE.md, but it does not specify how this style guide will be used or enforced. Instructions on following the style guide should be provided.
• The updates to the faq.md file do not seem to address any major issues or significantly improve the existing content. Discussions with the author about the necessity of these changes and potential improvements should be considered.
• The links to the WasmEdge documentation and community resources in the faq.md file should be checked for accuracy and currency.
• The moved and renamed files could potentially break existing references or URLs, and therefore they should be reviewed and updated if needed.
• It is important to ensure that the moved and renamed files are correctly reflected in the overall project structure and navigation.

Key Findings:

• The patch adds a FAQ page in both English and Chinese.
• It introduces a style guide for both documentation and coding.
• A troubleshooting guide is added and the appropriate files are moved and renamed.
• No potential problems were identified in the patch.

Additional Recommendations:

• Review the changes based on the project's coding and documentation style guidelines to ensure consistency.
• Verify that any added or changed links or references are correctly pointing to the intended destinations.

Overall, the patch brings several additions and updates related to the FAQ page, style guide, and troubleshooting guide. Some potential issues and errors should be addressed and reviewed.

Details

Commit 6a5c4a884bae8bb4e4587aca8bbe3bdb44d1e2c3

Key Changes:

• Added a new FAQ page in the docs/develop/getting-started/faq.md file.
• Added a Chinese version of the FAQ page in the i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started/faq.md file.

Potential Problems:

• No potential problems found in the patch.

Commit 3c88c86ea0199f86f7f5b75aea6c451a3162ddd7

Key changes in the patch:

1. Added a new file STYLE_GUIDE.md that provides a style guide for both documentation and coding.
2. Updated the faq.md file by making minor changes to the content and adding new links to the WasmEdge documentation and community resources.

Potential problems:

1. The patch introduces a new file STYLE_GUIDE.md, but it does not specify how this style guide will be used or enforced. It would be beneficial to provide instructions on how contributors should follow this style guide.
2. The updates to the faq.md file do not seem to address any major issues or improve the existing content significantly. It might be worth discussing with the author if these changes are necessary or if there are other potential improvements.
3. The links to the WasmEdge documentation and community resources in the faq.md file should be checked to ensure they are correct and up-to-date.

Commit 5a3c420de069c22d85d831f574d709bd9e21628c

Key changes:

• Moved the FAQ page from the "docs/develop/getting-started" directory to the "docs/start" directory.
• Renamed the "STYLE_GUIDE.md" file to "docs/start/style_guide.md".
• Created a new FAQ page in the "i18n/zh/docusaurus-plugin-content-docs/current/start" directory.
• Added links to the FAQ page and Style Guide in the "docs/start/overview.md" file.

Potential problems:

• The patch does not include any code changes, only file movements and renames. Therefore, it is difficult to identify potential problems without further context.
• It is possible that the moved files and renamed files could break any existing references or URLs that were pointing to the old file locations. This should be carefully reviewed and updated if necessary.
• It is also important to ensure that the moved files and renamed files are properly reflected in the overall project structure and navigation.

Additional considerations:

• It is recommended to review the changes based on the project's coding and documentation style guidelines to ensure consistency.
• If any links or references were added or changed in the patch, it is important to verify that they are correctly pointing to the intended destinations.

Commit a7f3f7bcf4e982f98abc36a7e48c7a4a20c945db

Key Changes:

• Added a "Troubleshooting Guide" page to the "start" directory.
• Renamed the "troubleshooting_guide.md" file in the "docs/develop/getting-started" directory to "docs/start/troubleshooting_guide.md".
• Renamed the "troubleshooting_guide.md" file in the "i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started" directory to "i18n/zh/docusaurus-plugin-content-docs/current/start/troubleshooting_guide.md".

Potential Problems:

• No potential problems were identified in this patch.

Overall, this patch adds a "Troubleshooting Guide" page and updates the file structure accordingly.

[alabulei1]

Hi @mhmohona

It seems that #197 includes this PR. Should I merge this PR?

[adithyaakrishna]

@mhmohona I guess this PR is very different from #197. The #197 PR adds testing docs while this PR adds the FAQs. IMHO, it would be good to have the faq page

CC @alabulei1 Could you please review it once again, as I personally feel, having a faq page for the project would be good

[mhmohona]

Hey @adithyaakrishna, thanks for your review! In above comment @alabulei1 meant #198 actually.

[alabulei1]

Hi @mhmohona

could you please remove your faq page the style guide to https://wasmedge.org/docs/start/overview. We have a separate chapter for getting started. Thanks!