Where things are documented
All of it is published as docs.scmjs.dev, built by
npm run build:docs (scripts/build-docs.mjs) and deployed by build.yml's docs job on
a tag, like the hosted editor. Two halves: these documents split at their ## headings
into pages, and the plugin API reference generated from the bundled plugin-api/index.d.ts
— so a doc comment in src/plugins/api.ts is a paragraph on the site, and a member with
none shows as a bare signature. Nothing on the site is prose a generator wrote, and these
files stay where all of it is maintained.
| Topic | File |
|---|---|
| What the editor does, for map makers | ../README.md |
| CHK and MPQ handling, section coverage | file-formats.md |
| Extracting and using Blizzard data | game-data.md |
| The trigger scripting language | the Trigger Script plugin's README |
| Writing and installing plugins, the plugin API | plugins.md |
| Per-subsystem implementation notes | ../CLAUDE.md |
| Provenance of adapted code and data | ../ATTRIBUTION.md |