update

Author: tom-sapletta-com

README.client.md

@@ -0,0 +1,38 @@
+# coBoarding – Dokumentacja Klienta
+
+## Spis treści
+- [Opis systemu](#opis-systemu)
+- [Szybki start](#szybki-start)
+- [Konfiguracja poczty email](#konfiguracja-poczty-email)
+- [Wysyłanie zgłoszeń i powiadomień](#wysylanie-zgloszen-i-powiadomien)
+- [FAQ](#faq)
+- [Wsparcie i kontakt](#wsparcie-i-kontakt)
+
+---
+
+## Opis systemu
+coBoarding to system automatyzujący wypełnianie formularzy rekrutacyjnych oraz wysyłanie powiadomień email. Umożliwia szybkie przesyłanie zgłoszeń, odbieranie kodów logowania i śledzenie statusów aplikacji.
+
+## Szybki start
+1. Skopiuj wybrany plik `.env.gmail`, `.env.ms` lub `.env.prv` do `.env` i uzupełnij swoimi danymi.
+2. Uruchom system zgodnie z instrukcją od dostawcy.
+3. Wysyłaj zgłoszenia przez interfejs lub API.
+
+## Konfiguracja poczty email
+- W pliku `.env` ustaw dane SMTP i IMAP zgodnie z Twoim dostawcą poczty (przykłady w repozytorium).
+- Twoje dane są bezpieczne – nie są wysyłane do twórców systemu.
+
+## Wysyłanie zgłoszeń i powiadomień
+- Możesz otrzymywać podsumowania zgłoszeń na email (pole `notify_email` w zgłoszeniu).
+- Możesz pobierać kody logowania (2FA) automatycznie przez `/get-email-token`.
+
+## FAQ
+**Czy moje dane są bezpieczne?**
+Tak, dane logowania do poczty są trzymane wyłącznie lokalnie w pliku `.env`.
+
+**Jak mogę uzyskać pomoc?**
+Napisz do wsparcia technicznego lub sprawdź sekcję [Wsparcie i kontakt](#wsparcie-i-kontakt).
+
+## Wsparcie i kontakt
+- Kontakt: support@coboarding.com
+- Dokumentacja online: [docs.coboarding.com](https://docs.coboarding.com)

README.developer.md

@@ -0,0 +1,51 @@
+# coBoarding – Dokumentacja Deweloperska
+
+## Spis treści
+- [Architektura systemu](#architektura-systemu)
+- [Szybki start dla dewelopera](#szybki-start-dla-dewelopera)
+- [Struktura repozytorium](#struktura-repozytorium)
+- [Opis usług i API](#opis-uslug-i-api)
+- [Integracja z bazą i email](#integracja-z-baza-i-email)
+- [Testowanie i debugowanie](#testowanie-i-debugowanie)
+- [Wskazówki bezpieczeństwa](#wskazowki-bezpieczenstwa)
+- [FAQ dla deweloperów](#faq-dla-deweloperow)
+
+---
+
+## Architektura systemu
+coBoarding to architektura mikroserwisowa oparta o Dockera, z usługami: browser-service, llm-orchestrator, web-interface, novnc i innymi.
+
+## Szybki start dla dewelopera
+1. Sklonuj repozytorium i przejdź do katalogu `python`.
+2. Skonfiguruj `.env` według szablonu.
+3. Uruchom środowisko przez `docker compose up` lub skrypty `dev.sh`/`run.sh`.
+
+## Struktura repozytorium
+- `containers/` – Dockerfile i kod usług
+- `infra/` – ansible, playbooki
+- `model-configs/`, `data/`, `output/` – modele, dane, wyniki
+
+## Opis usług i API
+- Szczegóły endpointów: `/fill-form`, `/get-email-token`, `/health`, `/api/health`
+- Przykłady requestów i odpowiedzi w dokumentacji kodu
+
+## Integracja z bazą i email
+- Wysyłka emaili przez `send_email_utils.py` (SMTP, załączniki)
+- Pobieranie kodów przez `email_utils.py` (IMAP)
+- Logowanie statusów do SQLite (`form_status.db`)
+
+## Testowanie i debugowanie
+- Testy endpointów: `scripts/test_infra.sh`
+- Logi kontenerów: `docker compose logs <usługa>`
+- Debugowanie SMTP/IMAP: zmienne środowiskowe `.env`
+
+## Wskazówki bezpieczeństwa
+- Nigdy nie commituj danych z `.env`!
+- Używaj kont testowych do developmentu
+
+## FAQ dla deweloperów
+**Jak dodać nowy endpoint?**
+Dodaj funkcję w odpowiednim pliku API, zarejestruj trasę w Flask.
+
+**Jak dodać nową usługę?**
+Dodaj nowy katalog w `containers/` i Dockerfile, zarejestruj w docker-compose.

README.md

@@ -1,5 +1,14 @@
 # coBoarding
 
+---
+
+## Dokumentacja
+
+- [Dokumentacja dla Klienta](./README.client.md)
+- [Dokumentacja dla Dewelopera](./README.developer.md)
+
+---
+
 coBoarding to kompleksowy, kontenerowy system do automatycznego wypełniania formularzy rekrutacyjnych, kładący nacisk na prywatność, elastyczność oraz wsparcie wielojęzyczne.
 
 <!-- coBoarding SVG Logo -->