Appearance
Dokumentacja Wellysa
Repozytorium dokumentacji medycznej i prawnej Wellysa — dokumenty produktowe, oświadczenia, umowy i specyfikacje techniczne.
📁 Struktura projektu
EN/ # English documentation
├── Dokumentacja systemów informatycznych (IT)/
│ ├── dokumentacja-systemu-wellysa-2.0.md
│ ├── specyfikacja-systemu-wellysa-3.0.md
│ └── wycena-wellysa-3.0.md
├── karty-onkoradar/ # OnkoRadar product cards (7 files)
│ ├── OnkoRadar Basic.md
│ ├── OnkoRadar Omni.md
│ ├── Karta OnkoRadar Max Risk.md
│ ├── Karta OnkoRadar Pierwiastki.md
│ ├── Karta OnkoRadar Pierwiastki Plus.md
│ ├── OnkoRadar Telekonsultacja.md
│ └── Obsługa produktów OnkoRadar w Synevo instrukcja.md
├── oświadczenia/ # Legal declarations (6 files)
├── umowy/ # Contracts
├── wellysa-dokumenty/ # Company documents (10 files)
│ ├── Regulamin usługi Wellysa.md
│ ├── Polityka prywatności Wellysa.md
│ ├── Warunki usługi Wellysa.md
│ ├── Zgoda na badania genetyczne.md
│ ├── Zgoda na badania naukowe.md
│ ├── Często zadawane pytania.md
│ └── Zespół Wellysa.md
└── README.md # EN documentation index
_clickup-exports/ # ClickUp project exports
_granty/ # Grant applications
├── _20260130-innostar/ # InnoStar application files
.git-hooks/ # Git automation hooks
.github/workflows/ # CI/CD pipelines
├── build-docs.yml
└── generate-pdfs.yml
KONFIGURACJA_KROK_PO_KROKU.md # Setup guide
SETUP.md # Installation instructions
TROUBLESHOOTING.md # Common issues & fixes🚀 Szybki start
Dokumentacja angielska znajduje się w katalogu EN/.
Dla szczegółowego indeksu wszystkich dokumentów zobacz EN/README.md.
🏗️ Stack technologiczny
- Primary format: HTML (27.4 MB) — static documentation site
- Source format: Markdown (.md files) w katalogach tematycznych
- CI/CD: GitHub Actions (automatyczne buildy)
- PDF generation: XeLaTeX (wsparcie polskich znaków)
- Translation pipeline: Google Gemini 2.5 Flash API (unverified — confirm with team)
🤖 Automatyzacja
GitHub Actions workflows
Każdy push do main automatycznie:
- 📄 Generuje PDF-y w językach PL i EN z pełnym wsparciem Unicode (XeLaTeX)
- ☁️ Uploaduje na Google Drive w strukturze folderów PL/EN (unverified — confirm with team)
- 📦 Tworzy GitHub Release z wszystkimi PDF-ami do pobrania (unverified — confirm with team)
- 📧 Wysyła email z podsumowaniem i linkami (unverified — confirm with team)
Lokalne generowanie PDF
bash
# Szczegóły w SETUP.md i KONFIGURACJA_KROK_PO_KROKU.mdTłumaczenie dokumentów (PL → EN)
bash
# 1️⃣ Uzyskaj darmowy klucz API Gemini: https://makersuite.google.com/app/apikey
export GEMINI_API_KEY="AIzaSy..."
# 2️⃣ Przetłumacz dokumenty (smart skip — tylko zmienione pliki)
npm run translate # (unverified — confirm package.json config)
# 3️⃣ Commit PL + EN razem
git add docs/ EN/ # (unverified — confirm source directory)
git commit -m "docs: update with EN translation"
git push⚡ Smart skip: tłumaczenie przetwarzane są tylko zmienione pliki, oszczędzając quota API.
📦 Zawartość repozytorium
Dokumenty produktowe (EN/karty-onkoradar/)
- OnkoRadar Basic, Omni, Max Risk, Pierwiastki, Pierwiastki Plus
- Instrukcje obsługi produktów OnkoRadar w Synevo
- Karta telekonsultacji OnkoRadar
Dokumenty prawne (EN/oświadczenia/)
- Oświadczenia pacjenta (historia onkologiczna, pełnoletność, pochodzenie, ubezwłasnowolnienie)
- Oświadczenie o rezygnacji ze zwrotu
Dokumenty firmowe (EN/wellysa-dokumenty/)
- Regulamin i warunki usługi Wellysa
- Polityka prywatności
- Zgody na badania genetyczne i naukowe
- FAQ i informacje o zespole
Specyfikacje IT (EN/Dokumentacja systemów informatycznych (IT)/)
- Dokumentacja systemu Wellysa 2.0
- Specyfikacja systemu Wellysa 3.0
- Wycena Wellysa 3.0
Granty (_granty/)
- Wnioski o dofinansowanie (InnoStar)
- Dokumentacja projektowa i oświadczenia
🔧 Setup
Szczegółowe instrukcje instalacji i konfiguracji:
- SETUP.md — podstawowa konfiguracja środowiska
- KONFIGURACJA_KROK_PO_KROKU.md — przewodnik krok po kroku
- TROUBLESHOOTING.md — rozwiązywanie problemów
📝 Kontrybucje
Przed edycją dokumentów zapoznaj się z:
- Git hooks w
.git-hooks/(auto-formatting, validation) - Workflows w
.github/workflows/(automated builds) - Naming conventions w strukturze katalogów
💡 Cechy projektu
- ✅ Markdown source of truth — czytelne i verzjonowalne pliki źródłowe
- ✅ Automatyczna generacja PDF przez GitHub Actions
- ✅ Pełne wsparcie Unicode (XeLaTeX) dla polskich znaków
- 🌍 AI-powered translation (PL → EN) via Google Gemini 2.5 Flash (unverified)
- ⏭️ Smart skip — tłumaczy tylko zmienione pliki (unverified)
- 📦 GitHub Releases z gotowymi PDF-ami do pobrania (unverified)
🌍 Powered by Google Gemini 2.5 Flash — AI translation at no cost (250 requests/day) (unverified — confirm with team)
⏭️ Smart skip — only translates modified files (unverified — confirm with team)
⚠️ Note: Sekcje oznaczone (unverified) wymagają weryfikacji z zespołem — nie udało się zweryfikować tych funkcji na podstawie widocznej struktury repozytorium.