Skip to content

docs: improve environment setup documentation for local development #7

@NEXARA-oss

Description

@NEXARA-oss

##problem

The current setup instructions are missing detailed explanations for environment variables and local runtime requirements.

New contributors may struggle to start the project locally.


Goal

Improve onboarding documentation for first-time contributors.


Tasks

  • document required environment variables
  • explain local development setup
  • add troubleshooting section
  • improve setup examples
  • verify commands work on Windows/Linux/macOS

Acceptance Criteria

  • setup instructions are easy to follow
  • contributors can run the project locally
  • missing env variables are documented
  • troubleshooting section is added

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions