Skip to content

Commit 4b4ef93

Browse files
ACM-JaverianaACM-Javeriana
authored
Merge pull request #6 from CapituloJaverianoACM/develop
Docs
2 parents 4245891 + b7385a3 commit 4b4ef93

27 files changed

+869
-37
lines changed

‎.env.example‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ DEPLOY_TARGET=test # default to 'test' or 'prod' when running deploy-commands
1010
SMTP_API_KEY=
1111
SMTP_API_URL=
1212
SMTP_FROM=
13-
SMTP_API_TIMEOUT_MS=
13+
SMTP_API_TIMEOUT_MS=

‎DOCUMENTATION.md‎

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
# 📚 Resumen de Documentación
2+
3+
## ✅ Archivos Documentados
4+
5+
Este documento resume la documentación agregada a todo el proyecto del Bot de Discord.
6+
7+
---
8+
9+
## 🗂️ Archivos Principales
10+
11+
### 📄 `src/index.ts`
12+
**Punto de entrada del bot**
13+
- ✅ Documentación del módulo y su propósito
14+
- ✅ JSDoc para interfaces (`BotClient`)
15+
- ✅ Comentarios sobre filtro de advertencias
16+
- ✅ Documentación de variables clave (token, client)
17+
- ✅ Explicación del sistema de carga de comandos
18+
- ✅ Explicación del sistema de carga de eventos
19+
20+
### 📄 `src/deploy-commands.ts`
21+
**Script de deployment de comandos**
22+
- ✅ Descripción del archivo y su uso
23+
- ✅ Documentación de variables de configuración
24+
- ✅ JSDoc para función `loadCommands()`
25+
- ✅ JSDoc para función `deploy()`
26+
- ✅ Ejemplos de uso en comentarios
27+
28+
### 📄 `src/list-commands.ts`
29+
**Utilidad para listar comandos**
30+
- ✅ Descripción del propósito del script
31+
- ✅ Documentación de variables
32+
- ✅ JSDoc para función `main()`
33+
- ✅ Instrucciones de uso
34+
35+
---
36+
37+
## 🎮 Comandos
38+
39+
### 📄 `src/commands/announce.ts`
40+
**Sistema de anuncios**
41+
- ✅ Descripción del comando y sus capacidades
42+
- ✅ JSDoc para función `execute()`
43+
- ✅ Documentación de opciones del comando
44+
45+
### 📄 `src/commands/clear.ts`
46+
**Limpieza de mensajes**
47+
- ✅ Descripción completa del sistema de limpieza
48+
- ✅ Documentación de flags y constantes
49+
- ✅ JSDoc para función `execute()`
50+
- ✅ Explicación de unidades (mensajes/horas/días)
51+
52+
### 📄 `src/commands/event.ts`
53+
**Gestión de eventos programados**
54+
- ✅ Descripción del sistema de eventos
55+
- ✅ Documentación de tipos de eventos (external/voice)
56+
- ✅ JSDoc para función `execute()`
57+
- ✅ Documentación de subcomandos
58+
59+
### 📄 `src/commands/ping.ts`
60+
**Comando de latencia**
61+
- ✅ Descripción simple y clara
62+
- ✅ JSDoc para función `execute()`
63+
- ✅ Explicación del cálculo de roundtrip time
64+
65+
### 📄 `src/commands/presence.ts`
66+
**Configuración de presencia**
67+
- ✅ Descripción de rich presence
68+
- ✅ JSDoc para función `execute()`
69+
- ✅ Documentación de tipos de actividad
70+
- ✅ Explicación de estados
71+
72+
### 📄 `src/commands/setup.ts`
73+
**Configuración inicial del servidor**
74+
- ✅ Descripción completa del comando
75+
- ✅ Lista de elementos configurables
76+
- ✅ JSDoc para función `execute()`
77+
- ✅ Documentación de roles y canales
78+
79+
### 📄 `src/commands/ticket-close.ts`
80+
**Cierre de tickets**
81+
- ✅ Descripción del sistema de cierre
82+
- ✅ JSDoc para función `execute()`
83+
- ✅ Documentación de permisos requeridos
84+
85+
### 📄 `src/commands/ticket-message.ts`
86+
**Publicación de mensaje de tickets**
87+
- ✅ Descripción del sistema de tickets
88+
- ✅ JSDoc para función `execute()`
89+
- ✅ Explicación del emoji 🎫
90+
91+
### 📄 `src/commands/verify.ts`
92+
**Verificación por email**
93+
- ✅ Descripción del proceso de dos pasos
94+
- ✅ JSDoc para función `maskEmail()`
95+
- ✅ JSDoc para función `execute()`
96+
- ✅ Documentación de subcomandos (start/code)
97+
- ✅ Explicación de prevención de reutilización
98+
99+
---
100+
101+
## 🎭 Eventos
102+
103+
### 📄 `src/events/ready.ts`
104+
**Evento de bot listo**
105+
- ✅ Descripción del evento
106+
- ✅ JSDoc para el manejador
107+
- ✅ Documentación de propiedades (name, once, execute)
108+
109+
### 📄 `src/events/guildMemberAdd.ts`
110+
**Evento de nuevo miembro**
111+
- ✅ Descripción del sistema de bienvenida
112+
- ✅ JSDoc para el manejador
113+
- ✅ Explicación del envío de embeds
114+
115+
### 📄 `src/events/messageCreate.ts`
116+
**Evento de creación de mensaje**
117+
- ✅ Descripción del evento
118+
- ✅ JSDoc para el manejador
119+
- ✅ Documentación del comando fallback !ping
120+
121+
### 📄 `src/events/messageReactionAdd.ts`
122+
**Evento de reacción agregada**
123+
- ✅ Descripción del sistema de tickets
124+
- ✅ JSDoc para el manejador
125+
- ✅ Explicación del proceso de creación de tickets
126+
- ✅ Documentación de permisos y categorías
127+
128+
### 📄 `src/events/voiceStateUpdate.ts`
129+
**Evento de cambio de estado de voz**
130+
- ✅ Descripción completa del sistema Voice Master
131+
- ✅ JSDoc para función `scheduleCleanup()`
132+
- ✅ JSDoc para función `buildControls()`
133+
- ✅ JSDoc para el manejador principal
134+
- ✅ Documentación del tiempo de limpieza (5 minutos)
135+
136+
### 📄 `src/events/interactionCreate.ts`
137+
**Evento de interacción**
138+
- ✅ Descripción completa del manejador
139+
- ✅ JSDoc para función `handleVoiceMasterSelect()`
140+
- ✅ JSDoc para función `handleVoiceMasterModal()`
141+
- ✅ JSDoc para función `applyPermit()`
142+
- ✅ JSDoc para función `applyReject()`
143+
- ✅ JSDoc para función `applyInvite()`
144+
- ✅ JSDoc para función `showModal()`
145+
- ✅ JSDoc para función `showSelector()`
146+
- ✅ JSDoc para función `updateControlStatus()`
147+
- ✅ Documentación de flags efímeros
148+
149+
---
150+
151+
## 🛠️ Utilidades
152+
153+
### 📄 `src/utils/embed.ts`
154+
**Constructor de embeds**
155+
- ✅ Descripción del módulo
156+
- ✅ JSDoc para interface `EmbedOptions`
157+
- ✅ JSDoc para función `buildEmbed()`
158+
- ✅ JSDoc para función `parseHexColor()`
159+
- ✅ Ejemplos en comentarios
160+
161+
### 📄 `src/utils/otp.ts`
162+
**Sistema de códigos OTP**
163+
- ✅ Descripción completa del sistema
164+
- ✅ JSDoc para interface `OtpEntry`
165+
- ✅ JSDoc para función `generateOtp()`
166+
- ✅ JSDoc para función `verifyOtp()`
167+
- ✅ JSDoc para función `pendingOtp()`
168+
- ✅ JSDoc para función `clearOtp()`
169+
- ✅ Documentación del TTL (10 minutos)
170+
171+
### 📄 `src/utils/mailer.ts`
172+
**Sistema de envío de correos**
173+
- ✅ Descripción completa del módulo
174+
- ✅ Documentación de métodos soportados (SMTP/HTTP)
175+
- ✅ JSDoc para interface `SmtpConfig`
176+
- ✅ JSDoc para interface `HttpMailConfig`
177+
- ✅ JSDoc para función `getConfig()`
178+
- ✅ JSDoc para función `getHttpConfig()`
179+
- ✅ JSDoc para función `maskEmail()`
180+
- ✅ JSDoc para función `describeSmtpError()`
181+
- ✅ JSDoc para función `sendOtpEmail()`
182+
- ✅ JSDoc para función `sendViaHttpApi()`
183+
- ✅ Documentación de variables de entorno
184+
185+
### 📄 `src/utils/voiceMasterState.ts`
186+
**Gestión de estado de canales de voz**
187+
- ✅ Descripción del módulo
188+
- ✅ JSDoc para interface `VoiceMasterState`
189+
- ✅ JSDoc para función `setVoiceState()`
190+
- ✅ JSDoc para función `getVoiceState()`
191+
- ✅ JSDoc para función `clearVoiceState()`
192+
- ✅ Documentación del almacén en memoria
193+
194+
### 📄 `src/utils/verifyRequest.ts`
195+
**Verificación de requests**
196+
- ✅ Descripción del placeholder
197+
- ✅ JSDoc para función `verifyRequestPlaceholder()`
198+
- ✅ Nota @todo para futura implementación
199+
200+
---
201+
202+
## ⚙️ Configuración
203+
204+
### 📄 `src/config/store.ts`
205+
**Sistema de almacenamiento**
206+
- ✅ Descripción completa del sistema
207+
- ✅ JSDoc para interface `GuildConfig`
208+
- ✅ JSDoc para interface `ConfigFile`
209+
- ✅ Documentación de variables de AWS S3
210+
- ✅ JSDoc para función `streamToString()`
211+
- ✅ JSDoc para función `loadFromBucket()`
212+
- ✅ JSDoc para función `saveToBucket()`
213+
- ✅ JSDoc para función `getGuildConfig()`
214+
- ✅ JSDoc para función `upsertGuildConfig()`
215+
- ✅ Explicación del sistema de caché

0 commit comments

Comments
 (0)