aboutsummaryrefslogtreecommitdiffstats
path: root/web
ModeNameSize
-rw-r--r--README.md2033logstatsplainblame
-rwxr-xr-xbuild-site1319logstatsplainblame
d---------demo361logstatsplain
-rw-r--r--index.html7719logstatsplainblame
-rwxr-xr-xinstall.sh1796logstatsplainblame
-rw-r--r--site.css5735logstatsplainblame

web — the slosh website

Everything the website is made of lives here (plus the docs generator, which make docs shares). One front page, the documentation, and the in-browser demo, assembled into a single static site:

path what comes from
/ the front page: what it is, the demo video, install index.html + site.css, hand-written, no build step
/docs/ the documentation contrib/gen-docs, the same pages make docs renders
/demo/ the in-browser machine demo/, on its own page so the front page stays light
/install.sh what curl \| sudo sh fetches install.sh here

Build

make www                    # everything -> build/www (same as web/build-site)
NO_DEMO=1 web/build-site    # without the demo (it cross-compiles a guest)
web/demo/serve --dir build/www

The output is only static files. Any host that serves a directory works, with the one condition the webdemo README already states: .wasm must be served as application/wasm.

Decisions

  • The page is drawn like a session. Tab strip as the nav, sections as panes with the title set into the frame, a status line at the bottom. The palette is contrib/themes/sl0p.kdl. This is what keeps it from looking like every generated landing page: it looks like slosh, because it copies slosh rather than a template.
  • The demo lives on its own page. Loading it costs ~11 MiB and a machine boot; the front page costs two files and no JavaScript beyond the copy buttons.
  • No framework, no fonts fetched, no tracker. Two files for the front page. The system monospace stack everywhere the terminal is being imitated.

TODO

  • The demo video is a placeholder (#video in index.html; the comment there says exactly what to replace). Drop in demo.mp4 + demo-poster.png when rendered.
  • install.sh clones https://slosh.foo/src (override: SLOSH_REPO=). Pin the real public repo URL once it exists — same for the src links in index.html.