🧭 Magikal Documentation

Welcome to the Magikal documentation pack.

This site documents the Magikal Discord bot, the Magikal web panel, the VPS runbooks, database rules, and developer workflow.

📡 Live docs status

These docs are published at https://docs.magikalbot.co.uk.

Documentation should match the current live project, not old memory or assumptions.

• 🤖 Discord Bot

  Commands, cogs, permissions, moderation, tickets, Temp VC, modlogs, Star Citizen tools, and admin features.

• 🖥️ Web Panel

  Login, server selection, configuration pages, layout rules, API routes, and permission behaviour.

• 🛠️ Operations

  VPS runbooks, service restarts, logs, backups, Git restore points, deployments, and migrations.

• 🧑‍💻 Developer Guide

  Coding rules, privacy rules, logging rules, database rules, and safe feature workflow.

📌 Documentation rule

When a feature changes, update the matching documentation page as part of the same patch.

🎨 Highlighting standard

Important safety notes, backup checks, migration warnings, rollback warnings, and privacy rules should be visually highlighted.

Use:

• bold text for normal important wording in the Magikal colour scheme
• marked text only for deliberate inline highlights
• !!! warning for caution
• !!! danger for stop-before-continuing warnings
• !!! tip for useful shortcuts
• custom callout blocks only when an instruction needs to stand out strongly

⚠️ Before continuing

Confirm the latest database backup is non-zero before migration work.

🧭 Emoji standard

Emojis should make pages easier to scan, not turn the docs into a Christmas tree.

Good uses:

• 🛠️ operations and server work
• 🔐 privacy/security rules
• 🗄️ database and migrations
• ✅ good output examples
• ⚠️ warnings
• 🚨 stop-before-continuing instructions
• 🧪 testing/checks
• 🤖 bot-specific docs
• 🖥️ panel-specific docs

Avoid using emojis in every sentence.

🚧 Current priorities

1. Finish the developer guide.
2. Document the current live bot commands and cogs.
3. Document the current web panel API and config pages.
4. Add screenshots and examples once the core pages are accurate.