Documentation Type
Setup/Installation guide
Location
README.md (development setup section), plus possible updates in CONTRIBUTING.md
Issue Description
The current README.md gives an overview of the project and some basic setup steps, but it may miss details that would help first-time contributors get started quickly. Some of the setup steps for iOS and Android (prerequisites, environment variables, troubleshooting) are not fully documented or could be clearer. There is also no single area for troubleshooting common onboarding errors.
Suggested Improvement
Expand the 'Development Setup' section of the README.md (and/or CONTRIBUTING.md) to include:
- Prerequisites (Node, NPM/Yarn/Bun, Xcode/Android Studio)
- Detailed steps for running on both iOS and Android
- List of any required environment variables
- Troubleshooting tips for errors new contributors might encounter
- Links to helpful React Native and related docs
All steps should be actionable and ordered so a first-time contributor can get the app running without prior project experience.
Checklist
Documentation Type
Setup/Installation guide
Location
README.md (development setup section), plus possible updates in CONTRIBUTING.md
Issue Description
The current README.md gives an overview of the project and some basic setup steps, but it may miss details that would help first-time contributors get started quickly. Some of the setup steps for iOS and Android (prerequisites, environment variables, troubleshooting) are not fully documented or could be clearer. There is also no single area for troubleshooting common onboarding errors.
Suggested Improvement
Expand the 'Development Setup' section of the README.md (and/or CONTRIBUTING.md) to include:
All steps should be actionable and ordered so a first-time contributor can get the app running without prior project experience.
Checklist