Current documentation lacks a dedicated section with clear, step-by-step setup instructions for both local development and VM environments. This guide will help ensure consistency and reduce setup-related issues for contributors.
Proposed Changes
Local Environment:
- List prerequisites (dependencies) for setup
- Provide installation steps for Windows and UNIX-based systems(can include docker ) .
- Include troubleshooting tips for common issues(?)
Cloud VM Setup:
- Steps for setting up development environment on cloud(UNIX based)
- Configuration guidelines for optimal resource allocation and network settings
Approach:
- create a new directory
docs/ in root and add readme files with detailed instructions