<img align="right" src="https://github.com/mearvk/SLeeLa/blob/master/images/debian/debian-logo.png" width="75" height="75" alt="SLeeLa">
SLeeLa Documentation Index
This page is the entry point for contributors and operators. It distinguishes normative specifications from implementation notes and live validation results.
Language and compiler
- SLeeLa International 3.0 — Language and Feature Reference — reader-facing overview of the language, compiler, runtime, standard library, syntax features, and implementation boundaries.
- Language syntax specification — normative SLeeLa
Syntax 3.0 grammar. The shared compiler gate in
impl/frontend/version.{h,cpp}accepts source syntax 1.0–3.1 and defaults unversioned source to 3.1 with a warning. Syntax 3.0 consolidates the established 1.x/2.x language surface while preserving each feature's original minimum-version gate. The@mixconsequent-field feature remains gated at 2.9 (§28); theprestigemarker in §27 remains a future proposal, not an implemented feature. Compiler/tool release numbers are independent of source syntax. See the syntax version matrix for feature history and implementation boundaries. Constructor overload resolution andthis(...)/base delegation remain outside the verified implementation and are rejected explicitly. - Compiler documentation — pipeline and version-aware behavior.
- Source and file format —
.sleelasource contract. - Library symbol inventory — canonical library vocabulary.
- Generated API documentation — the live
SleelaDoc HTML site for the whole
/libtree (Home → Package → Class → Members), regenerated from source bytools/generate-sleeladoc-api.py. Per-edition snapshots live underapi/sleela/; the current 3.1 edition (also written 3.01) is captured as immutable snapshots in numbered subfolders, starting atversion-001. The 3.0 edition and the older 2.x editions are preserved alongside it. Each later regeneration adds the next unusedversion-NNN/folder. - UI component quality — visibility, margin, and icon —
the
lib/uistandard layout model's per-component quality axes and howSLLayoutDriverrealizes each onto native widgets.
Modules
- Modules: tutorials and explanations — a verified tutorial or explanation for each of
the 44
sleelactlmodules and the 3 Advantage modules, with each module's measured state.
API documentation
- Generated API site — HTML reference generated from
/lib. - API documentation build guide — build destinations, versioned snapshots, and the
make api-docscommand. - Versioned API catalogue — native APIs and language editions.
Architecture and virtual machines
- SLVM/6 architecture — architecture, implementation boundaries, migration, and resolver lineage.
- SLVM/6 security — intended controls and evidence needed to verify them.
- Virtual-machine generations — generation-specific specifications and implementation references. A specification is not proof of complete runtime support.
- Virtual machines & Modium — hands-on user guide —
try-it guide for the
sleela vmselector (Native VM is the default) and thesleela modiumfile-resolution scan (SHA-256 + per-versionrebuild.sql). - General implementation architecture — boundary between the authoritative C/C++ implementation and the earlier Java prototype.
- Registry — Windows-style hierarchical registry
(settings, feature flags, per-artifact provenance + originality seal); the
master build materializes its baseline table (text store + MySQL export),
reviewable with
sleela registry. Sleela OOD mirror inlib/registry. - CPU stack — a complete CPU/OS/program machine in SLeeLa
source (gates → ALU → cores → OS → programs) plus a roster of 130+ CPU
profiles, each with per-architecture docs. Shared, adjustable timing is
documented in
Voltages, Variable Clocks, and Expert Timings
(
SLVoltageRail,SLCpuTiming,SLBusTiming,SLRamTiming,SLIOTiming, the Novice/Basic/Advanced/Expert tiers, and theSLTimingManifesta compiled.sleelaimage carries), and running a CPU at spec / overclocking it plus the RAM / storage / bus parts bin and DMA / GPU / native-RAM options are in the executor components guide. - Configuration guide — configuration root and runtime/VM settings.
Build, tests, and CI
- Native implementation guide — authoritative C/C++ build.
- Testing guide — local tests and translation-unit audit.
- Test-suite guide — broader suite entry points.
- Sleelavirin antivirus build and integrity — native scanner, optional ClamAV integration, SHA-256 source/index manifest, and release package checksums.
- Antivirus security and release checklist — index provenance, database snapshot integrity, safe scan behavior, and release gates.
- Antivirus binary build workflow — supported build matrix and release artifact packaging.
From the repository root, run make antivirus, make antivirus-test,
make antivirus-integrity, and
make antivirus-integrity-check MANIFEST=build/INTEGRITY-MANIFEST.json.
These checks document the build and integrity process; they do not replace
review of the exact commit's CI results or independently trusted release hashes.
The repo-root make all finishes by building the registry (the registry
target runs build-registry.sh), which materializes the
baseline registry table — the portable text store registry/build/sleela.sleelareg
and the MySQL script registry/build/registry.sql. Build it on its own with
make registry and review it with sleela registry or
registry/build/sleela-registry review.
- GitHub Actions — current run results.
Status note: the latest inspected Linux and Windows subject-test runs reported invalid-pointer crashes in the physics, economics, inference, and finance fixtures. This documentation update does not fix those runtime failures. Consult the live CI results and do not describe the full suite as green until a later run passes.
Documentation maintenance rules
- Update normative specs, implementation, and regression tests together when changing language behavior or supported syntax.
- Label design intent separately from behavior verified in the current build.
- Link security claims to the enforcing code and tests; distinguish technical controls from external certification.
- Report test results with the run/commit context and link to CI instead of implying a permanent pass from historical successes.
- Keep this index current when adding, renaming, or retiring core documentation.
SLeeLa
<p align="center"><img src="images/sleela/sleela-wordmark.svg" alt="SLeeLa — The Now. The Ingredient." width="560"></p> <p align="center"><img src="https://github.com/mearvk/SLeeLa/blob/master/images/sleela-programming-language-002.jpg" alt="SLeeLa Marketing Logo" width="560"></p>