diff --git a/README.md b/README.md index 0385c4b3..04b0690d 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,46 @@ Gaia is a decentralized AI infrastructure that empowers everyone to build, scale After forking and cloning the repository: -1. Install dependencies: - ``` - npm install - ``` -2. Start the development server: - ``` - npm start - ``` -3. Open your browser and visit `http://localhost:3000` +## 📋 Prerequisites + +**System Requirements:** +- Node.js 16.0 or higher +- npm 7.0 or higher +- Git + +**Check your versions:** +``` +node --version +npm --version +``` +## 🚀 Installation + +### Step 1: Clone and Setup +``` +git clone https://github.com/YOUR-USERNAME/docs.git +cd docs +npm install +``` + +### Step 2: Start Development Server +``` +npm start +``` + +### Step 3: View Documentation +Open your browser and visit `http://localhost:3000` + +### 🔧 Troubleshooting + +Port 3000 already in use? +``` +npm start -- --port 3001 +``` +Installation fails? +``` +rm -rf node_modules package-lock.json +npm install +``` ## Structure diff --git a/docs/getting-started/troubleshooting/troubleshooting.md b/docs/getting-started/troubleshooting/troubleshooting.md index e11d470c..f6f35d63 100644 --- a/docs/getting-started/troubleshooting/troubleshooting.md +++ b/docs/getting-started/troubleshooting/troubleshooting.md @@ -183,5 +183,34 @@ curl -sSfL 'https://github.com/GaiaNet-AI/gaianet-node/releases/latest/download/ This problem is fixed in `version 0.2.3`. +## Node Setup Problems +### "Illegal instruction (core dumped)" Error + +Problem: Your CPU doesn't support modern AVX instructions. +Solution: Install WasmEdge no-AVX version: +curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/master/utils/install_v2.sh | bash -s -- -v 0.13.5 --noavx +Then restart your GaiaNet node: +bashgaianet stop +gaianet start +Port Already in Use + +Problem: Port 8080 is already occupied. +Solution: Check what's using the port: +bashsudo netstat -tulpn | grep :8080 +Kill the process or use a different port in your config. +Memory Issues + +Problem: Node crashes with out of memory errors. +Solution: Ensure you meet minimum requirements: +4GB RAM minimum (8GB recommended) +10GB free disk space +RAG-Related Issues +Node Responds to General Queries but Not Specific Ones + +Problem: RAG database retrieval issues with domain-specific questions. +Solution: +Check your snapshot was properly imported +Review logs: ~/gaianet/log/start-llamaedge.log +Verify your knowledge base was correctly processed diff --git a/troubleshooting.md b/troubleshooting.md new file mode 100644 index 00000000..015d39ec --- /dev/null +++ b/troubleshooting.md @@ -0,0 +1,32 @@ +# 🔧 Troubleshooting Common Issues + +## Node Setup Problems + +### "Illegal instruction (core dumped)" Error + +Problem: Your CPU doesn't support modern AVX instructions. +Solution: Install WasmEdge no-AVX version: +curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/master/utils/install_v2.sh | bash -s -- -v 0.13.5 --noavx +Then restart your GaiaNet node: +bashgaianet stop +gaianet start +Port Already in Use + +Problem: Port 8080 is already occupied. +Solution: Check what's using the port: +bashsudo netstat -tulpn | grep :8080 +Kill the process or use a different port in your config. +Memory Issues + +Problem: Node crashes with out of memory errors. +Solution: Ensure you meet minimum requirements: +4GB RAM minimum (8GB recommended) +10GB free disk space +RAG-Related Issues +Node Responds to General Queries but Not Specific Ones + +Problem: RAG database retrieval issues with domain-specific questions. +Solution: +Check your snapshot was properly imported +Review logs: ~/gaianet/log/start-llamaedge.log +Verify your knowledge base was correctly processed