Orkuncakilkaya
ac1e8d157d
All checks were successful
docs / build-and-deploy (push) Successful in 2s
`System.*` and the newer `Os.*` (added in #21) both covered the environment around the game, with four members (`arg`, `arg_count`, `env`, `exit`) lowering byte-for-byte identically and the standard streams overlapping in concern. That is a user-facing ambiguity (`System.env` vs `Os.env` are indistinguishable) and a drift hazard (two copy-pasted codegen paths). Make `Os.*` the single canonical environment/process namespace and retire the overlapping `System.*` members: - Remove `System.{arg, arg_count, env, exit, stdout, stderr}` from the namespace dispatch (selfhost/emit_expr.ludic). Use `Os.arg`/`Os.arg_count`/`Os.env`/ `Os.exit` and `Os.stdout_write`/`Os.stderr_write` instead. - `System.*` now covers only its unique low-level surface: the raw file handles (`file_open/read/write/seek/tell/close`), `read_char`, and `run`. - The bare `arg`/`exit`/`getenv`/`file_stdout`/`file_stderr` intrinsics stay — they are the primitive layer the self-hosted compiler itself uses; only the redundant *namespaced* sugar is gone. - Docs: drop the six retired `docs/language/system/*` pages, retune the section blurb, update inventory.json and the LSP signature table. - Secondary finding from the issue: cross-link `Text.upper`/`Text.lower` (ASCII-only) to `Unicode.upper`/`Unicode.lower` (full Unicode case mapping). Reseeded; C-free bootstrap fixpoint holds. All suites green (56 test / 29 selfhost / 29 test-tools); docs cover every implemented feature (291 ns-methods). Closes #40 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| assets | ||
| check-impl.py | ||
| check.py | ||
| gen.py | ||
| inventory.json | ||
| palette.py | ||
| README.md | ||
| validate.py | ||
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.