Skip to content

Enhance Documentation: Setup Instructions for Local & VM Environments #23

@Grogu22

Description

@Grogu22

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions