McRogueFace/docs
John McCardle b32c5597fb Document threading contract; mcrfpy.lock() is the off-main-thread rule
Add docs/threading-model.md stating the normative rule (any access to mcrfpy
objects from a non-main thread must happen inside `with mcrfpy.lock():`;
behavior outside the lock is undefined), the FrameLock/safe-window design, and
a worked worker-thread example. Strengthen the mcrfpy.lock() docstring to state
the contract with an MCRF_LINK to the new page.

closes #327

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-02 20:23:05 -04:00
..
cookbook Cookbook: draft docs 2026-01-13 19:42:37 -05:00
stubs Fix #161: Update Grid, GridPoint, GridPointState stubs to match current API 2026-01-21 21:47:26 -05:00
templates draft tutorial revisions 2026-01-03 11:01:10 -05:00
tutorials Update all 13 tutorial scripts to current enum-based API, refs #167 2026-04-09 23:23:35 -04:00
api-audit-2026-04.md F15: correct docstring accuracy from adversarial verify pass (#314) 2026-06-21 06:43:47 -04:00
api_reference_complete.html docs: Add complete API reference documentation 2025-10-23 13:19:36 -04:00
API_REFERENCE_COMPLETE.md Squashed commit of the following: [alpha_presentable] 2025-07-15 21:30:49 -04:00
api_reference_dynamic.html Add read-only Caption.font getter; addresses #320 2026-06-21 12:18:53 -04:00
API_REFERENCE_DYNAMIC.md Add read-only Caption.font getter; addresses #320 2026-06-21 12:18:53 -04:00
EMSCRIPTEN_RESEARCH.md First successful Emscripten/WASM build for #158 2026-01-31 00:34:11 -05:00
ISSUE_TRIAGE_2026-04.md Fix outdated CLAUDE.md WASM audio entry; update triage notes 2026-04-20 14:37:48 -04:00
mcrfpy.3 Add read-only Caption.font getter; addresses #320 2026-06-21 12:18:53 -04:00
PROCEDURAL_GENERATION_SPEC.md HeightMap: core class with scalar operations (closes #193) 2026-01-11 20:07:55 -05:00
threading-model.md Document threading contract; mcrfpy.lock() is the off-main-thread rule 2026-07-02 20:23:05 -04:00
WASM_TROUBLESHOOTING.md Add WASM developer troubleshooting guide, closes #240 2026-04-10 03:31:43 -04:00