Create troubleshooting.md

[varvaraklimova102]

Add comprehensive troubleshooting guide for common issues

[juntao]

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

---

Overall Summary

The PR "Create troubleshooting.md" provides comprehensive instructions and solutions for common issues with Node setups, including handling "Illegal instruction (core dumped)" errors, managing port conflicts, ensuring minimum system requirements, and resolving RAG database retrieval problems specific to domain-specific queries. The guide is well-structured, includes clear steps, and provides detailed explanations of potential errors and their resolutions.

Potential Issues and Errors

1. Port Conflicts: Users might face issues where processes are using the default port 8080, which can interfere with the development server.
2. Memory Requirements: Ensure that the Node setup meets minimum system requirements to avoid performance issues or crashes.
3. AVX Support: The guide suggests checking for and installing WasmEdge if it's missing AVX support, as it can resolve "Illegal instruction (core dumped)" errors.
4. RAG Database Retrieval Issues: Users might encounter issues with RAG database retrieval, especially related to snapshot import or knowledge base processing. This includes troubleshooting steps such as verifying the snapshot and ensuring all necessary logs are reviewed.

Most Important Findings

1. Comprehensive Documentation: The guide covers a wide range of common issues, making it easy for new contributors to get started.
2. Clear Instructions: The steps provided in the guide are straightforward and easy to follow, enhancing user experience.
3. Detailed Explainsions: The guide provides detailed explanations for potential errors and their resolutions, which helps users understand how to troubleshoot issues effectively.

Next Steps

1. Review the Guide: Ensure that the guide is clear and comprehensive by reviewing it with peers or mentors.
2. Add Additional Sections: Based on more complex issues, add additional sections as necessary. This will help users address a wider range of problems more effectively.
3. Update Installation Instructions: Provide updated installation instructions for new contributors to follow, ensuring that they are consistent with the project's requirements.

By addressing these issues and providing clear, comprehensive documentation, the PR "Create troubleshooting.md" aims to make it easier for all users to set up and use Node effectively.

Details

Commit 12a2b1f22c44b53c87ed214839b445da2cc88331

Summary

• Comprehensive Troubleshooting Guide: Created a new file troubleshooting.md covering common issues with Node setups, including:

  • "Illegal instruction (core dumped)" errors related to missing AVX support.
  • Port conflicts and memory issues.
  • RAG database retrieval problems specific to domain-specific queries.

• Node Setup Issues:

  • Ensured WasmEdge's no-AVX version is used if necessary.
  • Checked for processes using port 8080 and killed them if needed.
  • Measured and ensured node resources meet minimum requirements.

• RAG Database Retrieval Issues:

  • Verified snapshot import.
  • Reviewed logs for issues in RAG database retrieval.

Next Steps

• Review the guide to ensure it is clear and comprehensive.
• Add additional sections as necessary based on more complex issues or further troubleshooting strategies.

Commit 610ad9c9b98bd85b1d7d15d2dd565d12c36c198b

Key Changes Summary

1. Updated README.md: Added sections for prerequisites, installation, and troubleshooting.
2. Added Prerequisites:
   • Installed Node.js 16.0 or higher
   • npm 7.0 or higher
   • Git
3. Improved Installation Guide:
   • Cloned the repository into a new directory
   • Installed dependencies using npm install
   • Started the development server with npm start
   • Provided instructions for running in production mode and troubleshooting common issues.
4. Structure: Added a heading "Structure" at the beginning of the document to summarize the contents.

These changes are important as they enhance the documentation by providing clear guidelines for setting up and using the project, which should be helpful for both new contributors and experienced users.

Commit fe91e43189498d2115da0c14d166046b1006a1e8

Key changes:

1. Added a new section in troubleshooting.md titled "Node Setup Problems".
2. Added details about the "Illegal instruction (core dumped)" error and how to resolve it by installing WasmEdge with no AVX instructions.
3. Added information about port conflicts, ensuring users check what's using the port.
4. Added memory issues with a detailed solution including minimum requirements.
5. Added RAG-related issues with a step-by-step guide on verifying the snapshot and knowledge base processing.

[harishkotra]

@varvaraklimova102 we already have a https://docs.gaianet.ai/getting-started/troubleshooting/ page. Please update your PR to use the same page with the common issues you created as part of this PR.

Let us know once you're done updating the PR and we'll review again.

Thank you for your contribution.

[varvaraklimova102]

@harishkotra Added what you asked for