Documentation Développeur — SciencesWiki

Portail technique du projet. Ces documents décrivent comment SciencesWiki est construit, pourquoi nous avons fait ces choix, et comment y contribuer. Ils s'adressent aux développeurs qui rejoignent le projet (désormais open source).

SciencesWiki est une encyclopédie scientifique sourcée. Elle moissonne les métadonnées de la littérature scientifique (via OpenAlex), les vectorise dans une base pgvector, et s'appuie sur un pipeline RAG (Retrieval-Augmented Generation) sourcé par construction pour produire des réponses et des articles de vulgarisation où chaque affirmation porte ses sources (DOI). Un vérificateur anti-hallucination marque les affirmations non étayées d'un [réf. nécessaire].

Sommaire

Nouveau sur le projet ? Commence par la Référence fonctionnelle (n°2) : elle relie chaque fonctionnalité à sa route/commande et à son code — tu sauras immédiatement ce qui existe et où regarder.

1. Architecture — vue d'ensemble du monorepo, schéma de déploiement générique, composants, modèle de données, flux principaux (moisson, RAG, analyse, texte intégral), asynchrone, temps réel, sécurité.
2. Référence fonctionnelle — catalogue précis de toutes les fonctionnalités (consultation, recherche, Q/R RAG, chat, outils chercheur, contribution, analyse, moisson, back-office…), chacune reliée à sa route / endpoint / commande et au code correspondant. La porte d'entrée du code.
3. Choix techniques — pourquoi ces décisions : Symfony 8 / API Platform, FrankenPHP, PostgreSQL+pgvector (vs base vectorielle dédiée), BFF Symfony/Twig (vs SPA), IA auto-hébergée (vs API payantes), RAG sourcé, « jeter le PDF / garder l'URL », JWT + session, etc.
4. Démarrage & environnement de dev — prérequis, lancer la pile en local, commandes console, tests, workflow de développement.
5. Conventions de code — style, structure, règles de nommage, patterns (Message/Handler, Mapper, Factory…), Doctrine/migrations, Twig, Dart, tests.
6. Contribuer & conventions de PR — workflow Git, format des commits, gabarit de Pull Request, critères de revue, licence.

Le dépôt en un coup d'œil

sciencesWiki/
├── apps/
│   ├── api/      → Cœur métier : Symfony 8 + API Platform (FrankenPHP).
│   │              Moisson OpenAlex, RAG pgvector, analyse, sécurité JWT.
│   ├── web/      → Front public Symfony/Twig — BFF (Backend-For-Frontend),
│   │              client server-side de l'API. Thème « CRT » rétro.
│   └── mobile/   → Application Flutter (consultation publique).
├── ml/           → Micro-service d'embeddings (FastAPI + sentence-transformers).
├── infra/        → Orchestration Docker Compose + reverse proxy + services IA.
├── docs/         → Spécifications et cette documentation développeur.
└── corpus/       → Échantillons de données (hors dépôt en production).

Pile technique en bref

Note sur l'hébergement : la production tourne sur un homelab, mais ces documents décrivent une topologie générique (reverse proxy + nœuds applicatifs + nœud données/IA) reproductible sur n'importe quel hébergeur. Les spécificités matérielles ne sont pas requises pour développer ou déployer.

← Sommaire · Le code est open source — voir Contribuer & PR.