c0ed23cc56
The failure this is against is not scope creep. It is abandonment by promotion:
a thing gets built to the point where it works, the next thing becomes more
interesting, and the first is left in a corner -- in the tree, not finished, not
deleted, and not in any list. Enough of those and the tree stops matching its
own documentation.
docs/plan/1.0.md now holds the register, and it is the only place anything
half-built is listed. Four sections, because the kinds are genuinely different:
built and connected to nothing (the text layer, a font from disk, socket
activation, wait_vblank); started and stopped part-way (foundations 2-5, hybrid
H2, Schcom v0, a released PCI device that nothing brings back); named in a "what
it does not do" and still true; and frozen -- scoped, unstarted, not to be
started. The rule is that nothing enters except by being finished or deleted,
and that adding a row requires closing one.
1.0.md already said "two things in flight, never three". It was right and it was
not being followed.
Then the corners themselves, because a register written over a tree full of them
is just a longer list:
- cmd/init is deleted. Nothing had execed /bin/init since initcode.S changed
to /bin/schinit; it was built and installed on every image as an unreachable
fallback, and an unreachable fallback rots rather than saves.
- projects/schwm/ and projects/schde/ are deleted. Both said "to be deleted"
in their own first paragraph, which proves only that a directory marked for
deletion is not deleted by being marked. README-only, no code lost, and the
arguments each made are moved into wayland.md where they are still true.
- projects/schcom/schcom and schcom-demo were tracked binaries. Untracked, and
.gitignore'd.
Three code comments and one document described a boot that has not happened
since 7d44eb7. cons_serial_only starts set, but kmain clears it on its first
lines now, so the splash does not survive the boot and the kernel log is on
screen from the start. That reversal was earned by a Chromebox with no serial
port freezing at boot showing nothing at all, and the comments still argued the
losing side of it.
The site:
- a download page. One ISO, what it has actually been run on -- one machine,
under test -- Ventoy and dd, what the first boot looks like step by step,
and the build if you would rather. The support table names one Chromebox
rather than listing hardware, because one Chromebox is the entire bare-metal
record and a list would be fiction.
- Assets/usb.svg, drawn to the same rule as the other marks: two tones,
geometry only, the accent spent in one place, and that place is the activity
light because it is the part that tells you something is happening.
- Download is in both navs and is the hero's primary action; a closing band
ends the front page on it.
- the uberblock-slots and drivers-outside-the-kernel figures are gone. Three
numbers left, including the fastfetch one, which stays because it is funny.
Two things caught by rendering the pages instead of assuming: .hero p was
beating .filemeta on specificity and the file line was coming out at body size,
and the dd command was one line long enough that the card clipped it at `conv=`
-- a destructive command that can scroll half of itself out of view is a good
way to take somebody's disk. It is two lines now.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VQ7Qx8E1q1M1bbCq8QLHS2
123 lines
5.3 KiB
Markdown
123 lines
5.3 KiB
Markdown
<!-- SPDX-License-Identifier: Apache-2.0 -->
|
|
# The website
|
|
|
|
Six 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
|
|
download.html get it, write it to a stick, or build it
|
|
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),
|
|
usb.svg (downloads), pride.svg
|
|
```
|
|
|
|
## The download page
|
|
|
|
`download.html` links to `releases/schos.iso`, a path relative to this
|
|
directory. **Nothing puts a file there** — the ISO is 62 MB and does not belong
|
|
in the repository — so the link is dead until a build is dropped next to the
|
|
site:
|
|
|
|
```sh
|
|
make iso
|
|
mkdir -p docs/Website/releases && cp schos.iso docs/Website/releases/
|
|
```
|
|
|
|
The page is written so that this is the only thing that needs doing, and so that
|
|
nothing on it is a promise the tree cannot keep. In particular the support table
|
|
says **one real machine, under test** rather than listing hardware, because one
|
|
Chromebox is the entire bare-metal record and a compatibility list would be
|
|
fiction. When that changes, change the table; do not soften the wording.
|
|
|
|
The `dd` command is split across two lines on purpose. It was one long line
|
|
first, and the card clipped it at `conv=` — a destructive command that can
|
|
scroll half of itself out of view is a good way to take somebody's disk.
|
|
|
|
## 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:
|
|
|
|
```sh
|
|
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 two footer notes
|
|
|
|
Both pages carry two statements below the licence line, and both are meant to
|
|
be read rather than skimmed past.
|
|
|
|
The first is the flag, below. The second is about AI, and it says the thing
|
|
worth saying: the tool is not the measure. A project is good when the people
|
|
building it understand what was built. That claim is deliberately made next to
|
|
a link to `history/`, because that directory is where it can be checked — the
|
|
bugs are written up in full, including the wrong turns and the measurements
|
|
that disproved them. An explanation you can follow is the evidence; the byline
|
|
is not.
|
|
|
|
## 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](../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](../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:
|
|
|
|
```sh
|
|
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.
|