docs: Write quetza docs
This commit is contained in:
15 files changed
+600
-12
No files matched your search
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
weight: 5
|
||||
---
|
||||
|
||||
|
||||
**Quetza** troubleshooting focuses on diagnosing structural and conceptual issues. Because of its convention-based nature, most errors are silent (missing files) rather than noisy (stack traces).
|
||||
|
||||
## Common Issue Categories
|
||||
|
||||
{{% cards %}}
|
||||
{{< card link="diagnostics" title="Diagnostics Guide" icon="exclamation" subtitle="Solutions for module discovery, command registration, and state leaks." >}}
|
||||
{{% /cards %}}
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: Diagnostics Guide
|
||||
weight: 1
|
||||
---
|
||||
|
||||
|
||||
**Goal:** Identify and fix common pitfalls in Quetza development.
|
||||
|
||||
## 1. Module Discovery Failures
|
||||
**Symptom:** The bot starts, but my module is ignored.
|
||||
**Cause:** Violation of filesystem conventions.
|
||||
|
||||
{{% details title="Checklist: Directory Structure" closed="false" %}}
|
||||
* [ ] Does `src/modules/<name>/` exist?
|
||||
* [ ] Does `module.ts` export `name`?
|
||||
* [ ] Are commands in `commands/` (not `cmds/`)?
|
||||
* [ ] Did you run `pnpm build`? (Quetza runs from `dist/`).
|
||||
{{% /details %}}
|
||||
|
||||
## 2. Command Registration Issues
|
||||
**Symptom:** `/command` does not appear in Discord.
|
||||
|
||||
### Global vs. Guild Registration
|
||||
* **Global:** Takes up to 1 hour to propagate.
|
||||
* **Guild:** Instant update.
|
||||
* **Fix:** Set `DEV_GUILD_ID` in your `.env` for development.
|
||||
|
||||
### Data Malformation
|
||||
Discord rejects invalid command structures silently or with generic errors.
|
||||
* **Name:** Must be lowercase, alphanumeric, `-` only.
|
||||
* **Description:** Required, max 100 chars.
|
||||
|
||||
## 3. Interaction Failures
|
||||
**Symptom:** "The application did not respond".
|
||||
**Cause:** Command took > 3 seconds without deferral.
|
||||
|
||||
**Solution:**
|
||||
```typescript
|
||||
// BAD
|
||||
await longRunningTask();
|
||||
await interaction.reply('Done'); // Too late!
|
||||
|
||||
// GOOD
|
||||
await interaction.deferReply();
|
||||
await longRunningTask();
|
||||
await interaction.editReply('Done');
|
||||
```
|
||||
|
||||
## 4. State Management Leaks
|
||||
**Symptom:** Bot memory usage grows; cross-server weirdness.
|
||||
**Cause:** Storing state globally instead of per-guild.
|
||||
|
||||
**Diagnostic:**
|
||||
Check your Controller.
|
||||
* ❌ `private player: AudioPlayer;` (Shared by everyone!)
|
||||
* ✅ `private players = new Map<string, AudioPlayer>();` (Scoped by ID).
|
||||
|
||||
## 5. Event Handling
|
||||
**Symptom:** Events fire multiple times or not at all.
|
||||
* **Multiple:** Events are additive. Did you register the same handler in two modules?
|
||||
* **None:** Did you export `name` and `execute` correctly?
|
||||
|
||||
> [!TIP]
|
||||
> **Debug Mode:**
|
||||
> Enable verbose logging to see exactly which modules and commands are loaded at startup.
|
||||
Reference in new issue
Block a user