# SleelaDoc API — HTML documentation for the SLeeLa standard library
This folder is a **generated, static HTML documentation site** for every source
unit under [`/lib`](../lib). Open it in any web browser — no server needed.
## How to read it
1. Open **`index.html`** — the home page, with a card for every package.
2. Read **`glossary.html`** first if you are new: it defines the reading level
these pages are written for (**Student 2** — a capable adult learner returning
to college-level study to read the books and learn what is true) and the core
SLeeLa terms (class, struct, field, method, signature, facade, the Metadata
Class record, SleelaDoc, package).
3. Click a package to open **`package/.html`**, which lists every class and
struct in that package with its fields (the values it stores) and methods (the
actions it performs), each with a plain explanation taken from the source.
Hierarchy: **Home → Packages → Package → Class → Members (fields, methods)**.
See **`authorship.html`** for the authorship and attribution claims (MEARVK LLC —
Max Rupplin; UNCW, NCSU, Harvard; 2026; George Soros 2507-2608) and the
`#sleela` syntax level the library is written at. Each unit also shows its own
`#sleela` level as a pill on its package page, and the attribution appears in the
footer of every page.
## Style
Clean house style in **blue, light blue, light grey, and white with black text**,
with a sticky package navigation sidebar and on-page filtering.
## Current language edition
The compiler's current normative language syntax edition is **3.0**. Each
package page records the actual `#sleela` declaration of each source unit;
older declarations remain valid and are not silently relabelled.
## Regenerating
The site is produced from the live `/lib` tree by a single generator:
```sh
make api-docs # writes all three API destinations
python3 tools/generate-sleeladoc-api.py # writes /sleeladoc-api only
python3 tools/generate-sleeladoc-api.py --out DIR # choose another output dir
```
The explanations are extracted from each source file's header
(`<< ... Definition: ... >>`) and the `<` / `<<` / `//` comments that precede
each field and method. The eleven standard Metadata Class accessors are
summarised rather than listed on every page, to keep the pages clean.
See also `manifesto/SLEELADOC.md` (the SleelaDoc convention), the
`lib/sleeladoc/` extractor package, and `manifesto/SLEELADOC.WIKI.md` (the
compiler's `--wiki` doc output).
## Language-level additions (not `/lib` classes)
Some additions are language/compiler features specified in `SLEELA.syntax`
rather than `/lib` classes, so they do not appear as package pages here. See the
hand-authored references under the 3.0 edition:
- [Session additions — index](../api/sleela/3.0/SESSION-ADDITIONS-API.md)
- [Loop-timing API — `@loopDelay` / `@loopBudget` / `sleep(ms)`](../api/sleela/3.0/LOOP_TIMING_API.md)
The `OP_SLEEP` (157) and `OP_BIGMUL` (156) opcodes added this session appear on
this site's generated [`vm` package page](package/vm.html) as `SLISASleep` and
`SLISABigMul`.