docs: overhaul and expand technical documentation
Revamped the documentation structure and content to enhance usability and organization. Added detailed sections on architecture, pipeline, security, API reference, deployment steps, compliance, and supported modules. Introduced new visuals like cards, accordions, and callouts for improved readability and navigation.
This commit is contained in:
@@ -5,15 +5,13 @@ description: Détails techniques du projet Memegoat
|
||||
|
||||
# 🐐 Détails Techniques - Memegoat
|
||||
|
||||
Ce document regroupe l'ensemble des spécifications techniques du projet Memegoat.
|
||||
Bienvenue dans la documentation technique de Memegoat. Ce portail centralise toutes les spécifications, modèles et guides nécessaires à la compréhension et à l'évolution de la plateforme.
|
||||
|
||||
## 🏗️ Architecture Globale
|
||||
|
||||
### Vue d'ensemble
|
||||
Memegoat repose sur une architecture **monorepo** moderne, garantissant une cohérence forte entre le frontend, le backend et l'infrastructure.
|
||||
|
||||
Description de l'architecture en monorepo et des interactions entre les services.
|
||||
|
||||
### Diagrammes
|
||||
### Interaction des Services
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
@@ -22,22 +20,48 @@ graph TD
|
||||
Frontend[Frontend: Next.js]
|
||||
Backend[Backend: NestJS]
|
||||
DB[(Database: PostgreSQL)]
|
||||
Storage[Storage: S3 Compatible]
|
||||
Storage[Storage: S3/MinIO]
|
||||
Cache[(Cache: Redis)]
|
||||
Monitoring[Monitoring: Sentry]
|
||||
|
||||
User <--> Caddy
|
||||
Caddy <--> Frontend
|
||||
Caddy <--> Backend
|
||||
Backend <--> DB
|
||||
Backend <--> Storage
|
||||
Backend <--> Cache
|
||||
Backend --> Monitoring
|
||||
```
|
||||
|
||||
### Navigation
|
||||
### Navigation Rapide
|
||||
|
||||
Consultez les différentes sections pour plus de détails :
|
||||
- [Fonctionnalités Techniques](/docs/features)
|
||||
- [Stack Technologique](/docs/stack)
|
||||
- [Modèle de Données](/docs/database)
|
||||
- [Sécurité](/docs/security)
|
||||
- [Conformité RGPD](/docs/compliance)
|
||||
- [API & Intégrations](/docs/api)
|
||||
- [Déploiement](/docs/deployment)
|
||||
Explorez les sections clés pour approfondir vos connaissances techniques :
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="🚀 Fonctionnalités"
|
||||
href="/docs/features"
|
||||
description="Détails des capacités techniques et du pipeline média haute performance."
|
||||
/>
|
||||
<Card
|
||||
title="🔐 Sécurité"
|
||||
href="/docs/security"
|
||||
description="Chiffrement PGP natif, Argon2id, RBAC et protection proactive ClamAV."
|
||||
/>
|
||||
<Card
|
||||
title="⚖️ Conformité"
|
||||
href="/docs/compliance"
|
||||
description="Mise en œuvre du RGPD, droit à l'oubli et portabilité des données."
|
||||
/>
|
||||
<Card
|
||||
title="📖 Référence API"
|
||||
href="/docs/api-reference"
|
||||
description="Documentation exhaustive de tous les points de terminaison de l'API."
|
||||
/>
|
||||
</Cards>
|
||||
|
||||
---
|
||||
|
||||
<Callout type="info">
|
||||
Cette documentation est destinée aux développeurs et aux administrateurs système. Pour toute question sur l'utilisation du site, merci de consulter l'aide en ligne sur [memegoat.fr](https://memegoat.fr).
|
||||
</Callout>
|
||||
|
||||
Reference in New Issue
Block a user