-
Notifications
You must be signed in to change notification settings - Fork 113
Open
Description
π Description
New contributors currently lack a comprehensive setup guide. The CONTRIBUTING.md lists prerequisites (Docker, Compose, Make) but stops without providing actual setup steps. The docs/ directory has only db.md and docker.md β there is no cross-platform developer onboarding guide.
π‘ Rationale
Multiple issues report setup-related problems that could be prevented with better documentation:
- Facing error while setting up repository for first time usersΒ #77 β
libGL.so.1missing dependency - Docker build fails with libGL.so.1 not found errorΒ #184 β Docker environment setup confusion
- [BUG]: Docker container missing OpenCV dependencies - ImportError on startupΒ #191 β Container configuration issues
- [BUG]: python-multipart and pypdf missing from requirements.txt Β #204 β
python-multipartnot listed in requirements.txt - [BUG]: Docker Environment Fails to Start API (Missing libGL and Port mapping)Β #224 β Port
8000not mapped in docker-compose.yml
A central setup guide consolidating these solutions would reduce repeated issue filings and help new contributors get started faster.
π οΈ Proposed Solution
- Enhance CONTRIBUTING.md β add development setup instructions, testing commands (
pytest), branch naming conventions (feat/,fix/,docs/), commit message guidelines, project structure overview, and useful links. - Create docs/SETUP.md β comprehensive cross-platform (Windows, macOS, Linux) setup guide with:
- Docker setup (5 steps) and local setup (6 steps)
- Environment variable reference (
OLLAMA_HOST,PYTHONPATH) - 6 common errors with fixes, each linked to the relevant issue
- Database reset instructions
- Architecture pipeline overview
- Documentation update in
docs/ - Update to CONTRIBUTING.md
β Acceptance Criteria
- CONTRIBUTING.md includes Quick Start steps for both Docker and local development
- docs/SETUP.md covers Windows, macOS, and Linux setup
- Common errors reference their corresponding GitHub issues
- All internal and external links resolve correctly
π Additional Context
Documentation-only changes β no application code is modified.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels