Skip to content

Commit ae2be13

Browse files
update
1 parent 1865c69 commit ae2be13

4 files changed

Lines changed: 37 additions & 32 deletions

File tree

README.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
# coBoarding
22

3-
```mermaid
4-
flowchart TD
5-
U[Użytkownik] -->|Web UI| WI(Web Interface)
6-
WI -->|Sterowanie| BS(Browser Service)
7-
WI -->|Komunikacja| LLM(LLM Orchestrator)
8-
BS -->|noVNC| NV(noVNC)
9-
LLM -->|API| BS
10-
WI -->|Integracja| PW(Bitwarden/PassBolt)
11-
```
12-
*Diagram architektury systemu (Mermaid)*
13-
143
coBoarding to kompleksowy, kontenerowy system do automatycznego wypełniania formularzy rekrutacyjnych, kładący nacisk na prywatność, elastyczność oraz wsparcie wielojęzyczne.
154

165
---
@@ -45,23 +34,7 @@ Pierwsze uruchomienie automatycznie skonfiguruje środowisko (venv, zależności
4534

4635
---
4736

48-
```mermaid
49-
sequenceDiagram
50-
participant U as Użytkownik
51-
participant WI as Web Interface
52-
participant LLM as LLM Orchestrator
53-
participant BS as Browser Service
54-
participant PW as Password Manager
55-
U->>WI: Start aplikacji
56-
WI->>LLM: Wykryj język, dobierz model
57-
WI->>PW: Pobierz dane logowania
58-
WI->>BS: Rozpocznij automatyzację
59-
BS->>WI: Wizualizacja przez noVNC
60-
BS->>LLM: Zapytania LLM
61-
LLM->>BS: Odpowiedzi
62-
WI->>U: Wyniki procesu
63-
```
64-
*Diagram przepływu działania (Mermaid)*
37+
[Diagramy architektury i przepływu znajdziesz w dokumentacji online (docs/architecture.md)](docs/architecture.md)
6538

6639
## Jak to działa
6740

@@ -130,8 +103,6 @@ System działa na architekturze mikroserwisowej (browser-service, llm-orchestrat
130103

131104
---
132105

133-
134-
135106
## Instalacja środowiska (Python 3.11+ / 3.12 na Ubuntu 24.10+)
136107

137108
Aby uniknąć problemów z kompatybilnością (np. PyAudio vs Python 3.12), zalecane jest użycie Pythona 3.11. **Na Ubuntu 24.10+ dostępny jest tylko Python 3.12 – patrz uwaga poniżej!**
@@ -413,7 +384,6 @@ Aplikacja działa w następujący sposób:
413384

414385
Całość działa w kontenerze Docker, co zapewnia łatwą instalację i uruchomienie na różnych systemach operacyjnych.
415386

416-
417387
---
418388

419389
<script type="module">

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# This enables navigation menu on GitHub Pages
33

44
# Set theme (minimal is simple and works well with navigation)
5-
theme: jekyll-theme-minimal
5+
theme: just-the-docs
66
mermaid: true
77

88
# Navigation menu for documentation (visible on GitHub Pages)

docs/architecture.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Architektura coBoarding
2+
3+
```mermaid
4+
flowchart TD
5+
U[Użytkownik] -->|Web UI| WI(Web Interface)
6+
WI -->|Sterowanie| BS(Browser Service)
7+
WI -->|Komunikacja| LLM(LLM Orchestrator)
8+
BS -->|noVNC| NV(noVNC)
9+
LLM -->|API| BS
10+
WI -->|Integracja| PW(Bitwarden/PassBolt)
11+
```
12+
13+
*Diagram architektury systemu (Mermaid)*
14+
15+
---
16+
17+
```mermaid
18+
sequenceDiagram
19+
participant U as Użytkownik
20+
participant WI as Web Interface
21+
participant LLM as LLM Orchestrator
22+
participant BS as Browser Service
23+
participant PW as Password Manager
24+
U->>WI: Start aplikacji
25+
WI->>LLM: Wykryj język, dobierz model
26+
WI->>PW: Pobierz dane logowania
27+
WI->>BS: Rozpocznij automatyzację
28+
BS->>WI: Wizualizacja przez noVNC
29+
BS->>LLM: Zapytania LLM
30+
LLM->>BS: Odpowiedzi
31+
WI->>U: Wyniki procesu
32+
```
33+
34+
*Diagram przepływu działania (Mermaid)*

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Testy end-to-end](e2e-tests.md)
1010
- [FAQ](faq.md)
1111
- [Kontakt](contact.md)
12+
- [Architektura](architecture.md)
1213

1314
---
1415

0 commit comments

Comments
 (0)