🚀 add documentation

makcimerrr · Jul 17, 2024 · 2bd7510 · 2bd7510
1 parent b1a52c2
commit 2bd7510
Show file tree

Hide file tree

Showing 10 changed files with 101 additions and 7 deletions.
diff --git a/docs/cogs/gestion_cdi.md b/docs/cogs/gestion_cdi.md
@@ -1,3 +1,23 @@
-# Gestion CDI
+# Module de Gestion des CDI, CDD, Freelance, Intérim etc...
 
-Ce module permet de gérer les CDI. Utilisez la commande `!cdi` pour interagir avec ce module.
+Ce module, intégré au bot Discord Zone01, est responsable de la gestion des offres d'emploi en CDI. Il utilise les APIs de LinkedIn et Indeed pour récupérer les dernières offres et les publier dans un canal spécifique.
+
+## Fonctionnalités
+
+### Commande `!update_cdi`
+- **Description** : Cette commande force la mise à jour des offres d'emploi en CDI, CDD, Freelance, Intérim, etc.
+- **Utilisation** : Lorsqu'un utilisateur exécute cette commande, un message de chargement est envoyé pour indiquer que la mise à jour est en cours. Le bot récupère alors les offres d'emploi depuis LinkedIn et Indeed et les publie dans un canal de forum dédié.
+
+### Processus de Mise à Jour
+1. **Récupération des Offres** : Le bot utilise les fonctions `fetch_linkedin_cdi` et `fetch_indeed_cdi` pour obtenir les offres d'emploi.
+2. **Création de Threads** : Pour chaque offre valide (titre, entreprise, lien), le bot crée un nouveau thread dans le canal de forum spécifié. Si un thread avec le même titre existe déjà, il passe à l'offre suivante pour éviter les doublons.
+3. **Gestion des Erreurs** : Si l'une des APIs échoue, le bot informe l'utilisateur via un message d'erreur approprié.
+
+### Autres Détails
+- **Canaux et Rôles** : Le module utilise des identifiants de canal et de rôle définis dans un fichier de configuration, facilitant la gestion des alertes pour les utilisateurs concernés.
+- **Latence et Débogage** : Des vérifications de latence sont intégrées, et le bot gère les erreurs liées aux appels API et à la création de threads.
+
+### Installation
+Pour activer ce module, utilisez la commande `!update_cdi` et suivez les instructions fournies par le bot. 
+
+Ce module contribue à rendre l'accès aux offres d'emploi plus accessible pour les apprenants, en centralisant les informations pertinentes dans un seul endroit sur Discord.
diff --git a/docs/cogs/gestion_help.md b/docs/cogs/gestion_help.md
@@ -0,0 +1,3 @@
+# Module de Gestion de la commande `!help`
+
+## SOON
diff --git a/docs/cogs/gestion_jobs.md b/docs/cogs/gestion_jobs.md
@@ -0,0 +1,3 @@
+# Module de Gestion des Alternances
+
+## SOON
diff --git a/docs/cogs/gestion_ping.md b/docs/cogs/gestion_ping.md
@@ -0,0 +1,3 @@
+# Module de Gestion de la Latence `!ping`
+
+## SOON
diff --git a/docs/config.md b/docs/config.md
@@ -0,0 +1,16 @@
+# Configuration
+
+Le bot nécessite un fichier de configuration pour fonctionner correctement. Voici comment le configurer :
+
+## Fichier `config.json`
+
+Le fichier `data/config.json` doit être structuré comme suit :
+
+```json
+{
+  "forum_channel_id": 1263144494115590337,
+  "forum_channel_id_cdi": 1263151656363753512,
+  "role_ping": 1245022469719457812,
+  "role_ping_cdi": 1263151656363753512
+}
+```
diff --git a/docs/contributor.md b/docs/contributor.md
@@ -0,0 +1,17 @@
+# Contribuer
+
+Merci de votre intérêt pour contribuer au projet Bot Discord Zone01 ! Voici comment vous pouvez aider :
+
+## 1. Rapport de bugs
+Si vous trouvez un bug, ouvrez un problème sur GitHub en fournissant autant de détails que possible.
+
+## 2. Soumettre une fonctionnalité
+Si vous avez une idée d'amélioration, n'hésitez pas à soumettre une proposition.
+
+## 3. Pull Requests
+- Fork le dépôt.
+- Créez une branche pour votre fonctionnalité ou correction de bug.
+- Effectuez vos modifications.
+- Ouvrez une Pull Request en décrivant les changements.
+
+Merci de respecter les bonnes pratiques de codage et d'ajouter des tests si nécessaire !
diff --git a/docs/guide/commandes.md b/docs/guide/commandes.md
@@ -1,7 +1,10 @@
 # Commandes
 
 Voici un aperçu des commandes disponibles dans le bot :
-- !help : Affiche l'aide.
-- !cdi : Gestion des CDI.
-- !jobs : Recherche de jobs.
-- !ping : Vérifie la connexion.
+
+- !help : Affiche l'aide et la liste des fonctionnalités.
+- !ping : Vérifie la latence du bot.
+- !update_jobs : Force la mise à jour des offres d'alternance.
+- !update_cdi : Force la mise à jour des offres CDI et CDD.
+
+D'autres commandes seront ajoutées prochainement pour améliorer la gestion du planning et faciliter l'entraide entre apprenants. Restez à l'écoute pour plus de fonctionnalités !
diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md
@@ -1,3 +1,20 @@
 # Introduction
 
 Ce document explique comment installer et configurer le Bot Discord Zone01.
+
+## Configuration
+
+Pour utiliser ce bot, vous devez :
+1. Avoir Python 3.7+ installé.
+2. Installer les dépendances nécessaires via `pip install -r requirements.txt`.
+3. Définir les variables d'environnement requises, notamment le TOKEN Discord.
+4. Éditer les id des channels et rôles, dans config.json, pour l'envoie et le ping des messages.
+
+## Variables d'Environnement
+
+- `TOKEN`: Token d'authentification de votre bot Discord.
+- `RAPID KEY`: Token pour l'accès aux API de [rapid](https://rapidapi.com/)
+
+## Utilisation
+
+Pour démarrer le bot, exécutez le fichier Python `bot.py`. Assurez-vous que votre bot a les autorisations nécessaires sur votre serveur Discord pour modifier les pseudonymes et gérer les rôles.
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,9 @@
 # Bienvenue dans la documentation du Bot Discord Zone01
 
-Ce bot est conçu pour faciliter la gestion des tâches liées à Discord. Consultez les sections suivantes pour en savoir plus sur son utilisation et ses fonctionnalités.
+Ce bot est conçu pour optimiser l'expérience des apprenants du campus en centralisant les offres d'alternance ainsi que les CDI et CDD. Grâce à des mises à jour quotidiennes à 10h et 18h, il puise des informations en temps réel via trois APIs puissantes : LinkedIn, Indeed et JSearch. 
+
+En plus de sa fonction de veille sur les offres d'emploi, le bot intègre des outils d'entraide pour la communauté. Une simple commande permet aux apprenants de demander du soutien, générant automatiquement une alerte pour mobiliser d'autres membres du campus. 
+
+Zone01 offre également un système de planning pour organiser les audits, permettant aux utilisateurs de sélectionner facilement des créneaux pour leurs passages.
+
+Explorez cette documentation pour découvrir toutes les fonctionnalités de Zone01 et comment elles peuvent enrichir votre expérience d'apprentissage !
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,6 +10,12 @@ nav:
           - Gestion Help: cogs/gestion_help.md
           - Gestion Jobs: cogs/gestion_jobs.md
           - Gestion Ping: cogs/gestion_ping.md
+  - Utilitaires:
+      - Utils:
+          - Fetch CDI: utils/cdi_fetcher.md
+          - Fetch Jobs: utils/job_fetcher.md
+          - Scheduler: utils/scheduler.md
+          - Config Loader: utils/config_loader.md
   - Configuration: config.md
   - Contribuer: contributor.md
 theme:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Module de Gestion de la commande `!help`

		## SOON
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Module de Gestion de la Latence `!ping`

		## SOON