SchOS/docs/Website/README.md

The website

Three files and a folder of marks. No build step, no dependencies, no framework — open index.html and it works, including from a file:// URL.

index.html    the front page
docs.html     the documentation reader
style.css     the palette, transcribed from include/theme.h
app.js        the front page: the boot log types, sections fade in
docs.js       the Markdown renderer and the doc index
Assets/       shift.svg (logo), uberblock.svg (SchFS), guru.svg (PSOGM),
              pride.svg

The docs reader

docs.html renders the Markdown in docs/ in the site's own theme, with the index down the left and a table of contents down the right. Links between documents are rewritten to stay inside the reader, so ../history/schfs.md in an architecture page navigates rather than downloads.

The parser is about 150 lines in docs.js and handles what docs/ actually uses: headings, fenced code, tables, lists, quotes, rules and inline marks. A Markdown library would be larger than everything else here put together. Every document is escaped before a single tag is emitted — the only HTML that reaches the page is HTML docs.js wrote.

This one page needs a server. Browsers refuse fetch() on file:// for the same reason they refuse it cross-origin, so opening docs.html from a file gives a panel explaining that instead of the docs. Everything else works from a file. To read them locally:

cd /home/nexoniarz/Dokumenty/Projects/SchOS
python3 -m http.server 8000
# then http://localhost:8000/docs/Website/docs.html

Adding a document means adding one line to the DOCS array in docs.js. The reader will only load a path that appears there.

The flag

Assets/pride.svg is in the top bar and in the footer, on both pages, and it is not seasonal. Support with an end date is marketing; this is a project that belongs to whoever writes it. It is also deliberately small — the site is about an operating system, and the flag is a statement, not a subject.

The rules it follows

The palette is not a design decision. It is include/theme.h, copied. A site describing an operating system should look like the operating system, and copying the header means the two cannot drift apart by accident.

PSOGM purple appears exactly once. #4B1D9A is on the crash-screen section and nowhere else, because ../branding/README.md says it means the machine stopped and that a colour used everywhere means nothing. If it shows up in a second place, that is a bug in the page.

The typefaces are the ones the OS ships. Roboto for text and JetBrains Mono for the system voice — both already in ports/, both already in NOTICE. They are requested from the system rather than downloaded: a font file would be larger than the entire rest of the site.

The script is optional. If app.js fails to load the page is still complete and still readable. Everything it does is decoration, and it honours prefers-reduced-motion by doing none of it.

The boot log is real. The lines in app.js are from an actual boot, not invented. The timer calibration line is there deliberately; see section 13 of ../history/kernel.md for what it cost.

Editing it

The numbers in the Numbers section are measured, not estimated, and they go stale. To refresh them:

find kernel include -name '*.c' -o -name '*.h' | xargs wc -l | tail -1
grep -c '^SYSCALL' kernel/sys/table.inc

The feature cards carry a tag — runs, in progress, or designed — and the tag is a promise. Anything marked runs is in the tree and works today. When that stops being true, change the tag rather than the wording.