Canary API Stability
How to work safely against Kinemium Canary's evolving API.
Canary API Stability
The Canary repository explicitly contains unstable changes. Build against it expecting API churn.
Recommended workflow
- Pin the exact Kinemium commit used by your project.
- Keep engine-facing code behind small wrappers.
- Prefer
game:GetService()and registered object/datatype APIs over helper modules. - Re-run your API inventory when updating Canary.
- Check a reference page's Source link whenever constructor/member behavior matters.
Documentation policy
This generated set separates:
- Registered classes: modules currently discovered from
src/environment/class/list. - Services: top-level service directories dynamically loaded by the data model.
- Datatype/runtime modules: every datatype directory module except the loader itself.
- Internals: registry helpers, bridges, service helper files, and similar modules are not presented as separate public APIs.
This keeps the docs synchronized with the runtime's discovery behavior instead of an older README shortlist.