danvics/docling-studio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
docling-studio/docs/community/onboarding-guide.md
Pier-Jean Malandrino f6030bb2f1 fix(docs): resolve mkdocs strict mode build failure (#145) 
- Add all process docs to mkdocs.yml nav (15 missing pages)
- Replace relative links to files outside docs/ with absolute GitHub URLs
- Add docs/audit/ directory (templates + reports)
- Add validation config to allow unlisted audit reports as info-level
2026-04-10 15:11:29 +02:00

3 KiB
Raw Blame History

Onboarding Guide — First Contribution

Welcome! This guide helps you go from zero to your first merged PR.

Prerequisites

Tool Version Check
Python 3.12+ python --version
Node.js 20+ node --version
Docker & Docker Compose latest docker compose version
Git 2.x git --version
Java (for e2e) 17+ java --version
Maven (for e2e) 3.9+ mvn --version

Step 1 — Fork & Clone

# Fork on GitHub, then:
git clone https://github.com/<your-username>/Docling-Studio.git
cd Docling-Studio
git remote add upstream https://github.com/scub-france/Docling-Studio.git

Step 2 — Run the Stack

The fastest way to see the app running:

docker compose up -d --wait
open http://localhost:3000

Step 3 — Set Up for Development

Backend

cd document-parser
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt          # remote mode (lightweight)
pip install ruff pytest pytest-asyncio httpx
uvicorn main:app --reload --port 8000

Frontend

cd frontend
npm install
npm run dev    # http://localhost:5173

Step 4 — Pick Your First Issue

Look for issues labeled:

  • good-first-issue — small, well-scoped, mentored
  • help-wanted — we need help but it may be larger
  • docs — documentation improvements (great starting point)

Step 5 — Create a Branch

git checkout main && git pull upstream main
git checkout -b feature/my-change    # or fix/my-fix

Follow the branching strategy.

Step 6 — Code

Step 7 — Verify

# Backend
cd document-parser
ruff check . && ruff format --check .
pytest tests/ -v

# Frontend
cd frontend
npm run type-check
npx eslint src/
npm run test:run

Step 8 — Commit & Push

Follow commit conventions:

git add <files>
git commit -m "feat(scope): short description"
git push origin feature/my-change

Step 9 — Open a PR

  • Target: main (or release/* for pre-release fixes)
  • Fill in the PR template
  • Add a line in CHANGELOG.md under [Unreleased]
  • Wait for CI to pass, then request a review

What to Expect

  • A maintainer will review your PR within 3 business days
  • You may get feedback — this is normal and helpful
  • Once approved, a maintainer will merge your PR
  • Your contribution appears in the next release's changelog

Need Help?