Skip to content

Commit

Permalink
⭐ add some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
makcimerrr committed Aug 21, 2024
1 parent d4d50ec commit d81ad31
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/cogs/embed_session_cog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ✨ Documentation de la Commande `/create_embed`

## Description

La commande `/create_embed` permet de créer un embed personnalisé. L'utilisateur remplit un formulaire avec des informations telles que le titre, la description, le pied de page, le nombre de sessions et le maximum de personnes par session. L'embed est ensuite envoyé dans le canal d'origine de la commande.

## Utilisation

**Commande :** `/create_embed`

### Paramètres

- **channel** *(Type : `TextChannel`)* : Le canal où l'embed de demande de session sera envoyé.

### Fonctionnement

1. **Formulaire de Création :** Un modal est présenté à l'utilisateur pour entrer les informations suivantes :
- **Event Title** *(Titre de l'événement)* 🎉
- **Description** *(Description de l'événement)* 📝
- **Footer** *(Pied de page de l'embed)* 📜
- **Number of Sessions** *(Nombre de sessions)* 🔢
- **How much by session** *(Nombre maximum de personnes par session)* 👥

2. **Envoi de l'Embed :** Une fois le formulaire soumis, l'embed est créé avec les informations fournies et est envoyé dans le canal où la commande a été exécutée.
3. **Ajout de Réactions :** Des réactions sont ajoutées à l'embed pour permettre aux utilisateurs de voter ou de répondre au sondage. ✅

### Exemple

```markdown
/create_embed channel:<#123456789012345678>
```
25 changes: 25 additions & 0 deletions docs/gestion_ask_help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 🛠️ Documentation de la Commande `/send_embed_help`

## Description

La commande `/send_embed_help` permet d'envoyer un message d'aide dans un canal spécifique. Le message inclut un embed avec un bouton pour demander de l'aide. Selon le rôle de l'utilisateur, le message est envoyé dans un canal déterminé.

## Utilisation

**Commande :** `/send_embed_help`

### Paramètres

- **channel** *(Type : `TextChannel`)* : Le canal où l'embed d'aide sera envoyé.

### Fonctionnement

1. **Envoi de l'Embed :** La commande envoie un embed dans le canal spécifié avec une description invitant les membres à demander de l'aide en cliquant sur le bouton ci-dessous.
2. **Ajout de la Vue (View) :** Un bouton pour demander de l'aide est inclus dans l'embed. Lorsque ce bouton est cliqué, un message d'aide est posté dans un canal approprié en fonction des rôles de l'utilisateur.
3. **Réponses et Réactions :** La commande ajoute des réactions au message pour simuler un sondage ou des réponses.

### Exemple

```markdown
/send_embed_help channel:<#123456789012345678>
```
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ nav:
- Gestion Jobs: cogs/gestion_jobs.md
- Gestion Ping: cogs/gestion_ping.md
- Gestion Event: cogs/event_cog.md
- Gestion Embed Session: cogs/embed_session_cog.md
- Gestion Ask Help: cogs/gestion_ask_help.md
- Utilitaires:
- Utils:
- Fetch CDI: utils/cdi_fetcher.md
Expand Down

0 comments on commit d81ad31

Please sign in to comment.