Feature/docs

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[dev]
+        pip install -e ".[dev]"
         pip install ruff bandit
 
     - name: Lint with Ruff

.github/workflows/pages.yml

@@ -0,0 +1,44 @@
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches: ["main"]
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs/
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -45,3 +45,9 @@ build/
 htmlcov/
 coverage.json
 scratch_cov.py
+
+# Docs Build
+docs/_site/
+.jekyll-cache
+docs/.jekyll-cache/
+_site/

CONTRIBUTING.md

@@ -259,10 +259,15 @@ Check the [issue tracker](https://github.com/416rehman/DeepZero/issues) for
 reported bugs. Engine improvements (better error messages, performance
 optimizations, new CLI features) are also highly valued.
 
-### Documentation
+### Documentation & Translations
 
-README clarifications, docstring improvements, and usage examples are always
-appreciated.
+The DeepZero documentation site is globally internationalized, supporting English (`en`), French (`fr`), Simplified Chinese (`zh-CN`), Russian (`ru`), Spanish (`es`), and Japanese (`ja`).
+
+When making changes or adding new files to the documentation:
+1. Always make your initial changes to the English source files in `docs/en/`.
+2. **Structural Parity is Required:** Every file in `docs/en/` must have an exact equivalent in the other 5 language directories to prevent 404 errors during locale switching.
+3. If you can provide native translations, please update the corresponding files in the other locale directories.
+4. If you cannot translate the content yourself, you **must still copy your English changes/files** over to the other language directories (`cp docs/en/my-file.md docs/ru/my-file.md`, etc.). Maintainers or community members will translate the English text later.
 
 ---
 

README.fr.md

@@ -0,0 +1,113 @@
+<div align="center">
+  <br>
+  <img src=".github/banner.svg" alt="DeepZero" width="700">
+  <br><br>
+  <p><b>Moteur de pipeline de recherche de vulnérabilités automatisé</b></p>
+  <p>Définissez des pipelines via YAML. DeepZero gère l'orchestration, le parallélisme, la tolérance aux pannes et l'état.</p>
+  <p>
+    <a href="https://github.com/416rehman/DeepZero/actions"><img src="https://img.shields.io/github/actions/workflow/status/416rehman/DeepZero/ci.yml?branch=main&style=flat-square" alt="CI"></a>
+    <a href="https://github.com/416rehman/DeepZero/blob/main/LICENSE"><img src="https://img.shields.io/github/license/416rehman/DeepZero?style=flat-square" alt="License"></a>
+    <img src="https://img.shields.io/badge/python-3.11+-blue?style=flat-square" alt="Python">
+    <img src="https://img.shields.io/badge/platform-windows%20%7C%20linux-lightgrey?style=flat-square" alt="Platform">
+  </p>
+</div>
+
+<br>
+
+<div align="center">
+  <img src=".github/terminal.svg" alt="Tableau de bord du terminal DeepZero" width="700">
+</div>
+
+<br>
+
+<div align="center">
+  <a href="README.md">English</a> | <a href="README.zh-CN.md">简体中文</a> | <b>Français</b>
+</div>
+
+<br>
+
+- 🔗 **Pipeline en YAML** - enchaînez de manière déclarative les étapes d'ingestion, de filtrage, de transformation et d'évaluation LLM
+- ⚡ **Exécution parallèle** - ThreadPoolExecutor avec une concurrence configurable par étape
+- 💾 **Exécutions reprenables** - état atomique par échantillon sur le disque ; appuyez sur Ctrl+C et relancez pour reprendre là où vous vous étiez arrêté
+- 🤖 **Intégration LLM** - modèles de prompts Jinja2 avec n'importe quel fournisseur LLM via [LiteLLM](https://github.com/BerriAI/litellm)
+- 🌐 **API REST (WIP)** - interrogez l'état de l'exécution et les données d'échantillons via HTTP (actuellement expérimental et incomplet)
+- 🧩 **Extensible** - écrivez des processeurs personnalisés sous forme de classes Python, et référencez-les par leur chemin dans YAML
+
+---
+
+## 📚 Documentation
+
+DeepZero dispose d'une documentation exhaustive couvrant l'architecture, les schémas de pipeline, les références de la CLI et le développement de processeurs personnalisés.
+
+👉 **[Lisez la documentation officielle ici (en anglais)](https://416rehman.github.io/DeepZero/)**
+
+---
+
+## ⚡️ Démarrage Rapide
+
+DeepZero nécessite un corpus cible de fichiers à analyser et une configuration de pipeline détaillant comment les traiter.
+
+1. **Cloner & Installer (Python 3.11+)**
+   ```bash
+   git clone https://github.com/416rehman/DeepZero.git
+   cd DeepZero
+   pip install -e .
+   ```
+
+2. **Configurer l'Environnement**
+   ```bash
+   cp .env.example .env
+   ```
+
+3. **Exécuter un Pipeline**
+   ```bash
+   deepzero run C:\drivers -p .\pipelines\loldrivers\pipeline.yaml
+   ```
+
+Pour des instructions de configuration détaillées et des exemples de corpus, consultez la [Documentation de Démarrage Rapide](https://416rehman.github.io/DeepZero/overview/quickstart.html).
+
+---
+
+## 📁 Structure du Dépôt
+
+```text
+src/deepzero/
+├── api/                 # API REST (starlette)
+├── engine/              # orchestration, persistance de l'état, exécution du pipeline
+└── stages/              # processeurs intégrés (map, reduce, ingest)
+
+processors/              # processeurs externes (fournis comme exemples)
+├── ghidra_decompile/    # décompilateur headless ghidra (MapProcessor)
+├── loldrivers_filter/   # filtre d'exclusion de hachage loldrivers.io (MapProcessor)
+├── pe_ingest/           # parseur d'en-tête PE et extracteur de métadonnées (IngestProcessor)
+└── semgrep_scanner/     # scanneur de lots semgrep (BulkMapProcessor)
+
+pipelines/
+└── loldrivers/          # pipeline de recherche de vulnérabilités pour les pilotes noyau BYOVD
+    ├── pipeline.yaml
+    ├── assessment.j2    # modèle de prompt LLM
+    └── rules/           # règles semgrep
+
+docs/                    # Documentation GitHub Pages basée sur Jekyll
+tests/                   # suite de tests pytest
+```
+
+---
+
+## 🤝 Contribuer
+
+L'intégration continue (CI) s'exécute sur Python 3.11 et 3.12 via GitHub Actions.
+
+Exécutez les vérifications de linting et de sécurité avant de soumettre :
+
+```bash
+ruff check . && ruff format --check . && bandit -ll -ii -c pyproject.toml -r .
+```
+
+Veuillez consulter le [Guide de Contribution](CONTRIBUTING.md) et le [Code de Conduite](CODE_OF_CONDUCT.md) avant de soumettre une pull request.
+
+---
+
+## 📄 Licence
+
+DeepZero est publié sous la [Licence MIT](LICENSE).