ludic/tools/docgen
Orkuncakilkaya a38195128f feat(stdlib): namespaced standard library (issue #2)
Implement the bulk of the namespaced-stdlib proposal (workshopsoft/ludic#2):
156 namespace methods across Math, Text, List, Ease, Collide, World, Net,
Sys, Save, Mem, extended Screen, Color functions, extended Random, and Time.
All deterministic fixed-point; self-hosting (C-free bootstrap fixpoint holds).

Compiler (selfhost/):
- Math.*: sqrt/sin/cos/tan/atan2/asin/acos (fixed-point runtime prelude —
  bit-by-bit isqrt, 256-entry interpolated sine table, Ross atan2), plus
  hypot/dist/dist2/deg_to_rad/rad_to_deg/posmod/wrap/ping_pong/snapped/
  move_toward/smoothstep/lerp/remap/sign/floor/ceil/round.
- Text.* (complete): upper/lower/trim/repeat/pad, split/join/replace,
  and the libc-backed queries.
- List.* (complete): insert/remove_at/remove/sort plus the earlier ops.
- Ease.* (in/out/in_out/back/bounce) and Collide.* (rects/point_rect/
  circles/rect_circle).
- Phase 3: World/Net/Sys/Save namespaced over the bare builtins (byte-
  identical IR) and Mem.* (bytes/words/copy/fill/peek/poke).
- Screen.* extended (line/circle/fill_circle/triangle/fill_triangle via new
  runtime primitives; sprite/sprite_scaled aliases), Color.* functions,
  Random.* (value/int/sign), Time.* (frame/delta/elapsed/now — new
  game-loop frame counter).
- Fix a lexer bug: fixed-point literals with >4 fractional digits overflowed.

Docs & tooling:
- 129 new per-symbol doc pages; gen.py made data-driven (namespaces
  discovered from the docs, no hardcoded list); new check-impl.py enforces
  that every implemented namespace method / keyword / type / phase has a
  doc page, wired into `x test-tools`. Document the previously-undocumented
  keywords (break/continue/where/entry/new/public + and/or/not tokens).
- LSP: namespaced signature help (ns_method_sig) covering every namespace.

Tests: 12 new self-host/regression tests + a golden render for the drawing
primitives. All suites green (selfhost 21, regression 45, tools 29).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-08-30 00:26:19 +03:00
..
assets docs(site): vertical pipeline on mobile, click tooltips, consistent chrome 2026-08-29 18:42:40 +03:00
check-impl.py feat(stdlib): namespaced standard library (issue #2) 2026-08-30 00:26:19 +03:00
check.py docs(api): per-symbol pages, fuzzy search, deep token linking, hover cards 2026-08-29 17:53:22 +03:00
gen.py feat(stdlib): namespaced standard library (issue #2) 2026-08-30 00:26:19 +03:00
inventory.json feat(stdlib): namespaced standard library (issue #2) 2026-08-30 00:26:19 +03:00
palette.py docs: automated documentation pipeline (per-symbol source → pages) 2026-08-29 16:25:54 +03:00
README.md docs(api): per-symbol pages, fuzzy search, deep token linking, hover cards 2026-08-29 17:53:22 +03:00
validate.py docs(api): per-symbol pages, fuzzy search, deep token linking, hover cards 2026-08-29 17:53:22 +03:00

Ludic documentation generator

Generates the public documentation site (the pages branch) from a single source of truth, so the site can never drift from the language.

Source of truth

docs/
  language/<category>/<id>.md    one file per symbol — keyword, type, phase,
                                 builtin, namespace method, operator, annotation
  language/<category>/_section.md   section title + blurb + order
  language/colors/palette.json   the 221 named colors (generated by palette.py)
  site/site.json                 landing-page messaging (hero, features, …)
  site/snippets/*.ludic          the code shown on the landing page (real programs)
tools/docgen/inventory.json      the authoritative symbol set the coverage guard checks

A symbol file

---
id: screen-fill_rectangle     # anchor + page name (screen-fill_rectangle.html)
name: Screen.fill_rectangle
category: screen
kind: namespace-method        # keyword|type|phase|namespace-method|builtin|annotation|operator
tokens: Screen.fill_rectangle # literal token(s) the highlighter matches & links
sig: Screen.fill_rectangle(x, y, width, height, color)
tip: Draw a solid, filled rectangle.     # one sentence — the hover-card summary
order: 1
ns: Screen                    # namespace-method only
member: fill_rectangle        # namespace-method only
related: screen-clear screen-draw_rectangle
---

Rich description — inline `<code>`/`backticks`, "model instance" language.

Parameters:                   # for anything that takes arguments
- `x` — the left edge, in pixels
- `color` — the fill color, e.g. a `Color.*` name

​```ludic
program Example { … descriptive-named, compilable … }
​```

What it produces

One page per symbol (<id>.html), a namespace overview page per namespace (ns-screen.html … ns-color.html), a searchable index (api.html, fuzzy search over every symbol), the landing page (index.html), the ludic-highlight.js highlighter (all its symbol tables, tips, per-item link targets, per-parameter anchors and hover-card data generated from the sources above), symbols.json, and .nojekyll.

In any code sample: keywords/types/builtins/annotations link to their page; Screen.fill_rectangle links Screen → the namespace page and fill_rectangle → the method page separately; a named argument like width: links to that parameter's anchor; Color.Charcoal links Color and Charcoal separately; hovering any token shows a summary card from the real API data.

Build & check

python3 tools/docgen/gen.py --out build/pages    # generate the whole site
python3 tools/docgen/check.py build/pages         # coverage + duplicate-token + link guard
python3 tools/docgen/validate.py                  # compile every ```ludic example with bin/ludicc

check.py fails CI if any symbol in inventory.json lacks a page, if a token is documented on two pages, or if a highlighter link points at a missing page — so "every symbol is documented, autogenerated each time" is enforced. validate.py needs a built bin/ludicc; the deploy CI is Python-only, so run it locally or in a toolchain-enabled job.

No third-party dependencies — Python standard library only.

Publish

.forgejo/workflows/docs.yml runs gen.py + check.py on every push to main that touches docs/** or tools/docgen/**, and publishes the result to the pages branch root. index.html + .nojekyll always stay at the root.

Colors

palette.json is generated by tools/docgen/palette.py from a single PALETTE table, which also generates selfhost/emit_color.ludic. Regenerate colors there.