Contributing to the WoW Server Dev Guide

Thanks for helping! This guide is a living project that gets better with community input.

---

How to Contribute

Report a Problem

Open an issue using one of the templates:

• Correction — SQL example has a wrong column name, ID doesn't exist, etc.
• Page Improvement — something's confusing, needs a diagram, missing a step
• New Topic Request — a topic that should be covered but isn't

Submit a Fix

1. Fork the repo
2. Edit the .md file in docs/
3. Open a Pull Request with a clear description of what you changed and why

---

Writing Rules

These rules exist so the guide stays consistent and beginner-friendly. All contributions must follow them.

Tone: ELI5 (Explain Like I'm 5)

• No jargon without immediate definition
• If you use a term for the first time, explain it in the same sentence
• Write like you're explaining to a friend who's never touched a database
• "The entry column is the creature's unique ID number" — not "entry is the PK"

Structure: Every Page Must Have

1. ASCII diagram at the top — show the concept visually before explaining in text
2. Hands-on exercise — at least one "type this, see that" exercise with expected results
3. Cheat sheet at the bottom — quick reference for the page's key commands/patterns

Progressive Disclosure

• Level 1 pages must NOT reference concepts from Level 2-4
• Level 2 can assume Level 1 knowledge, etc.
• If you need a concept from a later level, link to it with "(explained in File XX)"

SQL Examples

• All SQL must use real TrinityCore IDs that exist in a stock TDB import
• Common examples: Hogger (448), Stormwind Guard (68), Fireball (133)
• Always include WHERE in UPDATE/DELETE examples
• Show the DESCRIBE output or column names when referencing a table for the first time

ASCII Diagrams

Every page needs at least one. Use this style:

  +----------+     +----------+     +----------+
  | Step 1   | --> | Step 2   | --> | Result   |
  +----------+     +----------+     +----------+

• Indent 2 spaces
• Use +--+ for boxes, --> for arrows, | for vertical pipes
• Keep under 70 characters wide (mobile readability)

File Naming

• XX_Title_With_Underscores.md where XX is the number
• Numbers determine reading order within a level
• Home page is always index.md

Metadata

Add this at the very top of new pages:

---
title: Your Page Title
description: One-sentence summary for search results
last_verified: YYYY-MM-DD
tc_build: 66838
---

---

What NOT to Contribute

• Content that requires specific repacks or custom cores (keep it generic TrinityCore)
• Copyrighted Blizzard content (quest text, lore, datamined strings)
• Links to piracy, private server listings, or client downloads
• Anything that requires a retail WoW subscription to verify (the guide is for people with repacks)

---

Level Guidelines

Level	Audience	Assumes	Tone
1	Never touched a database	Can log into game as GM	Hand-holding, step by step
2	Can query and edit	Completed Level 1	Practical, example-heavy
3	Understands SQL, wants the "why"	Completed Level 2	Explanatory, connects dots
4	Ready to reverse-engineer	Completed Level 3	Technical, but still accessible

---

Local Development

To preview the site locally:

pip install mkdocs-material
mkdocs serve
# Open http://127.0.0.1:8000/

Changes to .md files auto-reload in the browser.