Skip to content

Commit e9209d9

Browse files
DanderBotDanderBot
committed
Initial site: WoW API changes reference (12.1.0 PTR), MkDocs Material + Pages deploy
0 parents  commit e9209d9

7 files changed

Lines changed: 602 additions & 0 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
# Allow one concurrent deployment, cancel in-progress runs for newer pushes.
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: true
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: actions/setup-python@v5
24+
with:
25+
python-version: "3.x"
26+
- name: Install dependencies
27+
run: pip install -r requirements.txt
28+
- name: Build site
29+
run: mkdocs build --strict
30+
- uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: site
33+
34+
deploy:
35+
needs: build
36+
runs-on: ubuntu-latest
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}
40+
steps:
41+
- id: deployment
42+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# MkDocs build output
2+
/site/
3+
4+
# Python
5+
__pycache__/
6+
*.pyc
7+
.venv/
8+
venv/

‎README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# WoW API Changes
2+
3+
A living reference of World of Warcraft Lua API changes between game builds, for addon developers.
4+
5+
**📖 Live site:** https://danderbot.github.io/wow-api-changes/
6+
7+
Each patch page lists new / changed / removed functions, events, structs, and enums — with full signatures — compiled from Blizzard's API documentation files (`Blizzard_APIDocumentationGenerated`) and addon source between two builds.
8+
9+
## Patches
10+
11+
- [12.1.0 (PTR) — vs 12.0.7](docs/patches/12.1.0.md)
12+
13+
## How it's built
14+
15+
The site is built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) and auto-deployed to GitHub Pages by a GitHub Action on every push to `main`. The contents page (left nav + per-page table of contents) and the search box are generated automatically from the markdown.
16+
17+
## Local preview
18+
19+
pip install -r requirements.txt
20+
mkdocs serve
21+
22+
Then open http://127.0.0.1:8000/.
23+
24+
## Contributing
25+
26+
Spotted an error or have a correction for a PTR change? Open an issue or a pull request against the relevant `docs/patches/<version>.md` file.

‎docs/index.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# WoW API Changes
2+
3+
A living reference of **World of Warcraft Lua API changes** between game builds — what's new, what changed, and what was removed each patch, with full function signatures, event payloads, struct fields, and enum values.
4+
5+
Built for addon developers. Each patch has its own page (see the navigation on the left). Use the **search box** at the top to jump straight to a function, event, struct, or namespace.
6+
7+
## Patches
8+
9+
- [**12.1.0 (PTR)** — vs 12.0.7](patches/12.1.0.md)
10+
11+
## How this is compiled
12+
13+
Each page is produced by comparing Blizzard's own API documentation files (`Blizzard_APIDocumentationGenerated`) between two game builds, cross-referenced against the shipped Blizzard addon source. Signatures and descriptions are grounded in the real doc files, not guessed.
14+
15+
!!! warning "Caveats"
16+
PTR data is subject to change before a patch goes live. Engine/runtime behaviour changes (taint rules, secret-value handling, `error → nil`) are **not** visible to a source diff — cross-check the official PTR patch notes and the WoW Dev Discord `#api-changes` channel.

‎docs/patches/12.1.0.md‎

Lines changed: 458 additions & 0 deletions
Large diffs are not rendered by default.

‎mkdocs.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
site_name: WoW API Changes
2+
site_description: A living reference of World of Warcraft Lua API changes between game builds (PTR and live), for addon developers.
3+
site_url: https://danderbot.github.io/wow-api-changes/
4+
repo_url: https://github.com/DanderBot/wow-api-changes
5+
repo_name: DanderBot/wow-api-changes
6+
edit_uri: edit/main/docs/
7+
8+
theme:
9+
name: material
10+
palette:
11+
- media: "(prefers-color-scheme: dark)"
12+
scheme: slate
13+
primary: deep purple
14+
accent: deep purple
15+
toggle:
16+
icon: material/weather-night
17+
name: Switch to light mode
18+
- media: "(prefers-color-scheme: light)"
19+
scheme: default
20+
primary: deep purple
21+
accent: deep purple
22+
toggle:
23+
icon: material/weather-sunny
24+
name: Switch to dark mode
25+
features:
26+
- navigation.instant
27+
- navigation.tracking
28+
- navigation.top
29+
- navigation.indexes
30+
- toc.follow
31+
- search.suggest
32+
- search.highlight
33+
- search.share
34+
- content.code.copy
35+
36+
plugins:
37+
- search
38+
39+
markdown_extensions:
40+
- toc:
41+
permalink: true
42+
- admonition
43+
- attr_list
44+
- tables
45+
- pymdownx.details
46+
- pymdownx.superfences
47+
48+
nav:
49+
- Home: index.md
50+
- Patches:
51+
- 12.1.0 (PTR): patches/12.1.0.md

‎requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mkdocs-material>=9.5,<10

0 commit comments

Comments
 (0)