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

[Feat] - Added New Docs #145

Merged
merged 11 commits into from
Sep 4, 2023
Merged

Conversation

adithyaakrishna
Copy link
Contributor

@adithyaakrishna adithyaakrishna commented Aug 8, 2023

Description:

This PR adds new docs which were missing from the book's site.

Copy link
Collaborator

alabulei1 commented Aug 8, 2023

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


Overall summary:

In this GitHub Pull Request titled "[Feat] - Added New Docs", multiple changes have been made to the documentation files. The changes include resolving conflicts, adding new documentation files for different use cases, adding a new category file, and fixing broken links.

The potential issues and errors identified in the pull request are as follows:

  • Lack of context: The summary does not provide enough context about the changes made and their purpose. It would be helpful to have a detailed description of what each file or category represents or adds to the documentation.
  • No tests: No tests or test cases were mentioned. It is always a good practice to include tests when adding new code or documentation to ensure its correctness and maintainability.
  • Unclear relation to a feature or issue: It's unclear if these changes are related to a specific feature or issue. Adding a reference to the related feature or issue in the pull request description can provide more context for reviewers and future readers.
  • File deletion: There are several files that have been deleted without clear explanation. It is important to ensure that the deletions are intentional and won't cause any issues or broken references.

The most important findings in the individual summaries are:

  • Significant deletions in the docu.js file, suggesting that the file is no longer needed or has been moved. Investigation is needed to ensure there are no dependencies or references to it elsewhere in the codebase.
  • Misplaced newline character in the docs/embed/c++/intro.md file, which should be corrected.
  • Typo in the word "microsoervices" in the docs/embed/use-case/mesh/dapr.md file, which should be corrected.
  • Empty docs/embed/use-case/mesh/eventmesh.md file, which should be addressed.
  • Unnecessary characters at the end of the URL in the docs/embed/use-case/reactr.md file, which should be removed.

Overall, the changes seem to focus on improving the documentation for embedding and using WasmEdge, with updates, deletions, and additions to various files. It is important to address the potential issues and errors identified and provide sufficient context and explanations for the changes made.

Details

Commit 8ad47afda6e084ee2c0d1cab54e5ee981fd686af

Key changes:

  • Resolved conflicts in multiple files.
  • Added new documentation files for different use cases: dapr.md, reactr.md, aws.md, netlify.md, secondstate.md, tencent.md, vercel.md, web-app.md, comparison.md.
  • Added a new category file for the mesh use case.

Potential problems:

  • The summary does not provide enough context about the changes made and their purpose. It would be helpful to have a detailed description of what each file or category represents or adds to the documentation.
  • No tests or test cases were mentioned. It is always a good practice to include tests when adding new code or documentation to ensure its correctness and maintainability.
  • It's unclear if these changes are related to a specific feature or issue. Adding a reference to the related feature or issue in the pull request description can provide more context for reviewers and future readers.

Commit 95b6fb1ddb4c80a0ba8ccd2cfa3816e5293dd3da

The key changes in this pull request are:

  • The addition and deletion of multiple files in the docs/embed and docs/start/wasmedge directories.
  • Updates to the content in the docs/embed/c++/intro.md, docs/embed/use-case/mesh/dapr.md, and docs/embed/use-case/reactr.md files.

The most important findings are:

  1. There are significant deletions in the docu.js file, which has been completely deleted. This suggests that the file is no longer needed or has been moved. It would be important to investigate why this file was removed and ensure that there are no dependencies or references to it elsewhere in the codebase.

  2. In the docs/embed/c++/intro.md file, there is a misplaced newline character at the end of the file. This should be corrected to maintain consistent formatting.

  3. The docs/embed/use-case/mesh/dapr.md file contains a typo in the word "microsoervices." It should be corrected to "microservices."

  4. The docs/embed/use-case/mesh/eventmesh.md file is empty. This should be addressed by either adding content or providing a note about its status.

  5. The docs/embed/use-case/reactr.md file has some unnecessary characters at the end of the URL for Reactr. These characters should be removed to ensure the URL is correct.

Overall, the changes seem to be focused on improving the documentation for embedding and using WasmEdge, with some updates and restructuring of the files and content.

Commit c60f8e1559130e755d142168da858acf1ba28795

Key changes in the patch:

  • Multiple files were deleted, including _category_.json, dapr.md, eventmesh.md, reactr.md, and secondstate.md.

Potential problems:

  • It's not clear why these files were deleted. Without more context, it's difficult to determine if these deletions were intentional or accidental.
  • The commit message and patch description do not provide enough information on the reasons for these changes or the impact they may have on the project.

Additional information or clarification from the developer is needed to properly assess the changes and identify any potential problems.

Commit 8e429cbfc879326db6cd66e2e32d8dc586b56c51

Key changes:

  • The broken links in the web-app.md file have been fixed.

Potential problems:

  • There are no major issues with this patch. The changes fix the broken links in the documentation.

Overall, this is a straightforward and necessary fix for the broken links in the documentation. It should be safe to merge.

Commit bacf9d6cb83307e86285bf351e676286be30da45

Key changes:

  • One line was removed from the file i18n/zh/docusaurus-plugin-content-docs/current/embed/use-case/web-app.md.
  • The removed line was regarding running the application in CRI-O or Kubernetes.

Potential problems:

  • Without further context, it is difficult to determine the impact of removing the line. It is important to consider whether this information was no longer relevant or if it was removed by mistake.

Commit debacb26db42e47663a5a5f20a5af639a2d4566e

Key changes:

  • Added a new category file docs/start/usage/_category_.json with content related to use-cases of WasmEdge.
  • Added a new use-case file docs/start/usage/use-cases.md with detailed information about the various use-cases of WasmEdge.
  • Added translations (zh) for both the category and use-case files.

Potential problems:

  • There don't appear to be any potential problems with these changes. The changeset looks clean and straightforward.

Commit 3e0a63109df98c48fe7d7c90d66732f1f683913c

Key changes in the patch:

  1. Reordered the contents in the "use-cases.md" file.
  2. Renamed and moved files related to serverless platforms under the "docs/start/usage" directory.
  3. Created new files for serverless platforms under the "docs/start/usage" directory.

Potential problems:

  1. The patch contains a large number of file content movements and renames, which can make it difficult to review and understand the overall changes.
  2. The patch introduces new files without any explanation of their purpose or content.
  3. It's unclear why the contents in the "use-cases.md" file were reordered and if there are any specific reasons for the new order.
  4. The commit message is not descriptive enough. It would be helpful to include more details about the changes made in this patch.

Commit 73402bd9616bf1ab64e9538b211da24b1bfff7ea

Key Changes:

  • Removed the documentation files related to serverless use cases and web applications.
  • Removed the JSON file for the "Serviceless Platforms" category.

Potential Problems:

  • It seems that all the documentation files related to serverless use cases and web applications have been deleted. This might result in missing or broken documentation links for these topics.
  • The removal of the "Serviceless Platforms" category JSON file might affect the structure and organization of the documentation.

Overall, it appears that the PR has removed certain documentation files and a category JSON file. However, there may be issues with missing or broken documentation links due to these deletions.

Commit 3b73941907458aa8a4fa8924a43791fe5d0542bb

Key changes in the patch:

  • The file docs/start/usage/web-app.md has been deleted.
  • The reference to web-app.md in the file docs/start/usage/use-cases.md has been updated.

Potential problems:

  1. Deletion of documentation: The file web-app.md has been completely removed. It is important to ensure that this deletion is intentional and that there are no dependencies or references to this file in other parts of the codebase. If there are any references to web-app.md elsewhere, they should be updated or removed accordingly.

  2. Broken link: In the file docs/start/usage/use-cases.md, the link to the serverless SaaS functions' documentation has been updated but the link text still refers to serverless/serverless-platforms. This should be corrected to match the new link.

These are the most important findings in the patch.

Commit c41e1b0dd3c3ed7bfa096ec73edff5993b0b19df

Key changes in the patch:

  • Fixed a broken link in the file "docs/start/usage/use-cases.md".
  • Removed the relative link for the Serverless SaaS (Software-as-a-Service) use case and replaced it with an absolute link to "/category/serverless-platforms".

Potential problems:

  • There doesn't seem to be any potential problems with this patch. It simply fixes a broken link and updates a relative link to an absolute one, which improves the accuracy and usability of the documentation.

Commit 12a9633dc9755714a892e7d3ceff5132fc17b3f4

Key changes:

  • The file wasm-smart-devices.md has been deleted.

Potential Problems:

  • It is not clear why the wasm-smart-devices.md file has been deleted. The Pull Request description or commit message should provide an explanation for this change.
  • If the wasm-smart-devices.md file contained important information or was referenced in other documentation or code, the deletion of this file could cause issues.
  • The Pull Request description is missing, making it difficult to understand the context and purpose of these changes.
  • It is advisable to have more descriptive commit messages that explain the reason for making the changes.

@adithyaakrishna
Copy link
Contributor Author

Oops! My bad, there are a hell lotta broken links, will fix them up :)

docs/embed/use-case/mesh/dapr.md Outdated Show resolved Hide resolved
docs/embed/use-case/reactr.md Outdated Show resolved Hide resolved
docs/embed/use-case/mesh/eventmesh.md Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/secondstate.md Outdated Show resolved Hide resolved
@adithyaakrishna
Copy link
Contributor Author

@alabulei1 Could you please review this PR?

docs/embed/use-case/serverless/_category_.json Outdated Show resolved Hide resolved
docs/embed/use-case/wasm-smart-devices.md Show resolved Hide resolved
docs/embed/use-case/web-app.md Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/_category_.json Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/aws.md Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/netlify.md Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/tencent.md Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/vercel.md Outdated Show resolved Hide resolved
docs/embed/use-case/web-app.md Outdated Show resolved Hide resolved
docs/embed/use-case/serverless/_category_.json Outdated Show resolved Hide resolved
docs/embed/use-case/wasm-smart-devices.md Show resolved Hide resolved
docs/embed/use-case/web-app.md Outdated Show resolved Hide resolved
docs/start/usage/web-app.md Outdated Show resolved Hide resolved
@alabulei1
Copy link
Collaborator

alabulei1 commented Aug 28, 2023

Hi @adithyaakrishna

Please check out my comments. Thanks. After you remove several docs, this PR can be merged.

@alabulei1
Copy link
Collaborator

Also there was a CI fail, please check it out. Thanks.

Adithya Krishna added 7 commits August 31, 2023 07:47
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Adithya Krishna added 3 commits August 31, 2023 07:52
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
Signed-off-by: Adithya Krishna <[email protected]>
@alabulei1 alabulei1 merged commit f0666d6 into WasmEdge:main Sep 4, 2023
6 checks passed
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.

[Feature] - Docusaurus SEO for Docs
2 participants