About these pages

Sources and versions

What the architecture, configuration and Alpenglow pages were written from. CI rebuilds the site on every merge to main and fills in the commit and versions below, so this page always describes the code it was built with.

Built from

Loading…

Versions referenced

Read from the repository by the build step. Each version links to the file it was read from, at the built commit.

Sources

The repository files each page cites, taken from the pages' own data. Links open at the built commit.

Upstream references

Cited by the Alpenglow page. Each is pinned to a tag, commit or crate version so its line anchors keep pointing at the quoted text; they are reviewed by hand, not updated by CI.

    How this stays current

    Every merge redeploys

    Each merge to main rebuilds and redeploys the site through the Pages workflow. The build step records the commit and reads the versions above from Cargo.toml, Cargo.lock, docker-compose.yaml, the Jetstreamer submodule and the Three.js import map, so they always match main.

    Pull requests are checked

    Pull requests that touch the site, its tests or the Rust and plugin sources run the site tests:

    • the configuration reference lists the same env vars and flags as the code, in both directions;
    • its YAML keys match FileConfig for superbank and superbank-verify;
    • every #[cfg(feature)] gate on an option carries its feature label;
    • every file a page cites exists;
    • the explorer and Alpenglow models follow their rules.

    What is not automatic

    Descriptions, defaults, diagrams and the upstream references are written by hand from the sources above. CI catches renamed, added and removed options, but not a description that has gone stale.

    Found a problem?

    Please open a pull request with the fix. Each page's content lives in a few files:

    Run node --test "tests/site/*.test.mjs" before opening it; the same tests run in CI.

    Open a pull request ↗