Orkuncakilkaya
3c7ec9b016
All checks were successful
docs / build-and-deploy (push) Successful in 2s
Rebuild the API Reference around one page per symbol and richer, verified content.
Pages & navigation
- One HTML page per symbol (kw-*, type-*, phase-*, screen-*, fn-*, annot-*, op-*)
instead of a single scrolling page; namespace overview pages (ns-screen …
ns-color) and a searchable index (api.html) with client-side fuzzy search.
- Sticky-header scroll offset (scroll-margin) so a jumped-to entry/param/color is
never hidden, plus a flash highlight on the scrolled-to target.
Deep linking in every snippet & example
- Namespace members split: `Screen`→namespace page, `fill_rectangle`→method page;
`Color`→palette page, `Charcoal`→its swatch — separately.
- Named arguments (`width:`) link to that parameter's anchor on the method page.
- Hover any token for a summary card built from the real API data (symbols.json).
Content & coverage
- Full authoritative surface documented from the compiler: every keyword, type,
the 6 phases (Start/Input/FixedUpdate/Update/LateUpdate/Render, each its own
page), all 22 annotations, namespace methods with parameter docs, builtins,
the world_* reflection ABI, networking, operators — 155 symbols.
- Longer, clearer explanations; "model"/"model instance" terminology, not "entity";
descriptive identifiers in every example (Position{column,row}, Velocity{delta_x,
delta_y}, Health{current,maximum}, Player/Enemy) — no Pos/Seg/x/dx.
- Accuracy fixes from compiler ground-truth: world_count() takes no arg,
world_query_next(property, cursor) arg order, event fields bind by name; dropped
`when` and `module` (not in the self-hosted parser).
Tooling
- inventory.json + check.py: coverage guard (every symbol has a page), duplicate-
token guard, and broken-link guard — fail CI so docs can't drift.
- validate.py: compiles every ```ludic example against bin/ludicc (158 compile).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
187 lines
3.1 KiB
JSON
187 lines
3.1 KiB
JSON
{
|
|
"annotations": [
|
|
"annot-queries",
|
|
"annot-computed",
|
|
"annot-onstart",
|
|
"annot-onquit",
|
|
"annot-onspawn",
|
|
"annot-ondespawn",
|
|
"annot-onattach",
|
|
"annot-ondetach",
|
|
"annot-onenable",
|
|
"annot-ondisable",
|
|
"annot-on",
|
|
"annot-public",
|
|
"annot-handles",
|
|
"annot-export",
|
|
"annot-reads",
|
|
"annot-writes",
|
|
"annot-sync",
|
|
"annot-owned",
|
|
"annot-server",
|
|
"annot-predicted",
|
|
"annot-toserver",
|
|
"annot-toclients"
|
|
],
|
|
"builtins": [
|
|
"fn-print",
|
|
"fn-str",
|
|
"fn-quit",
|
|
"fn-save",
|
|
"fn-load",
|
|
"fn-len",
|
|
"fn-push",
|
|
"fn-min",
|
|
"fn-max",
|
|
"fn-abs",
|
|
"fn-clamp",
|
|
"fn-fx",
|
|
"fn-flr",
|
|
"fn-bytes",
|
|
"fn-words",
|
|
"fn-ui_build",
|
|
"fn-arg_count",
|
|
"fn-arg",
|
|
"fn-exit",
|
|
"fn-run",
|
|
"fn-getenv",
|
|
"fn-read_char",
|
|
"fn-file_write",
|
|
"fn-file_stdout",
|
|
"fn-file_stderr"
|
|
],
|
|
"control": [
|
|
"kw-if",
|
|
"kw-while",
|
|
"kw-for",
|
|
"kw-in",
|
|
"kw-match",
|
|
"kw-machine",
|
|
"kw-state",
|
|
"kw-become"
|
|
],
|
|
"ecs": [
|
|
"kw-spawn",
|
|
"kw-despawn",
|
|
"kw-query",
|
|
"kw-self",
|
|
"kw-enable",
|
|
"kw-disable",
|
|
"kw-attach",
|
|
"kw-detach",
|
|
"fn-world_get",
|
|
"fn-world_set",
|
|
"fn-world_has",
|
|
"fn-world_count",
|
|
"fn-world_spawn",
|
|
"fn-world_size",
|
|
"fn-world_save",
|
|
"fn-world_load",
|
|
"fn-world_field_id",
|
|
"fn-world_prop_id",
|
|
"fn-world_model_id",
|
|
"fn-world_kind",
|
|
"fn-world_register_prop",
|
|
"fn-world_attach_dyn",
|
|
"fn-world_detach_dyn",
|
|
"fn-world_query_next"
|
|
],
|
|
"events": [
|
|
"kw-event",
|
|
"kw-emit",
|
|
"kw-cancel",
|
|
"kw-cancellable"
|
|
],
|
|
"input": [
|
|
"input-key"
|
|
],
|
|
"map": [
|
|
"map-size",
|
|
"map-row",
|
|
"map-tile"
|
|
],
|
|
"networking": [
|
|
"fn-net_send",
|
|
"fn-net_poll",
|
|
"fn-owner",
|
|
"fn-set_owner",
|
|
"fn-is_server",
|
|
"fn-is_owner",
|
|
"fn-local_id",
|
|
"fn-serialize",
|
|
"fn-apply"
|
|
],
|
|
"operators": [
|
|
"op-arith",
|
|
"op-compare",
|
|
"op-logical",
|
|
"op-bitwise",
|
|
"op-range",
|
|
"op-assign",
|
|
"op-access",
|
|
"op-interp",
|
|
"op-literals",
|
|
"op-comment"
|
|
],
|
|
"phases": [
|
|
"phase-fixedupdate",
|
|
"phase-input",
|
|
"phase-lateupdate",
|
|
"phase-render",
|
|
"phase-start",
|
|
"phase-update"
|
|
],
|
|
"random": [
|
|
"random-range",
|
|
"random-chance",
|
|
"random-seed"
|
|
],
|
|
"scenes": [
|
|
"kw-scene",
|
|
"kw-layer",
|
|
"kw-on",
|
|
"kw-enter",
|
|
"kw-exit",
|
|
"kw-start"
|
|
],
|
|
"screen": [
|
|
"screen-clear",
|
|
"screen-fill_rectangle",
|
|
"screen-draw_rectangle",
|
|
"screen-put_pixel",
|
|
"screen-draw_text",
|
|
"screen-draw_number",
|
|
"screen-show",
|
|
"screen-width",
|
|
"screen-height",
|
|
"screen-status"
|
|
],
|
|
"structure": [
|
|
"kw-program",
|
|
"kw-property",
|
|
"kw-model",
|
|
"kw-handler",
|
|
"kw-phase",
|
|
"kw-const",
|
|
"kw-var",
|
|
"kw-let",
|
|
"kw-fn",
|
|
"kw-return",
|
|
"kw-import",
|
|
"kw-extern",
|
|
"kw-ui",
|
|
"kw-enum"
|
|
],
|
|
"types": [
|
|
"type-int",
|
|
"type-fixed",
|
|
"type-bool",
|
|
"type-str",
|
|
"type-entity",
|
|
"type-ptr",
|
|
"type-words",
|
|
"type-byte",
|
|
"type-void",
|
|
"type-slices"
|
|
]
|
|
}
|