[pfeerick]

Summary

Ports the fix from @arkarkark's #10 to the MkDocs 2.12 docs:

• Relative paths: the current language's sound directory is prepended to a relative filename, not appended. luaPlayFile() writes the language path into the buffer first (getAudioPath()) and copies the filename after it.
• Example: the playFile("armed.wav", 5) comment said "use Wav volume 2". It now says 5. This example only appears in the LuaLS stubs and the internal review page.

How

The 2.12 API pages are generated from the firmware's luadoc comments. The upstream fix is EdgeTX/edgetx#7936. To avoid waiting for that PR and a full re-extract, which would also pull in unrelated firmware drift, I edited the playFile entry in the committed docs-system/generated/api-model.local.json to match the upstream fix and regenerated:

uv run python tools/docs_pipeline.py build --input docs-system/generated/api-model.local.json \
  --overlay-dir docs-system/overlays --docs-output website/md-docs/api-reference \
  --luals-output docs-system/generated/luals website/md-docs/assets/luals

Rebuilding from the unmodified model reproduces the committed tree exactly, so the only outputs that change are:

• the playFile page;
• its review page;
• the two runtime.d.lua stub copies.

mkdocs build --strict passes.

The next real re-extract from firmware produces the same text once EdgeTX/edgetx#7936 is in. That covers main/dev, and 2.12 too if the firmware fix is backported to the 2.12 branch.

Supersedes #10, credited as co-author.

🤖 Generated with Claude Code

[github-actions]

📖 Docs preview: https://pr-36-edgetx-lua-reference-guide.edgetx.workers.dev/2.12/

Built from c716825 as the 2.12 version, on top of the currently published site.