Docs: bring the documentation in line with the code
- Demo docs replaced by the screencast docs (single source of truth): the legacy demo-session.sh/demo-record.py and the v0.9 renderer were removed instead of being kept as a second convention. - feature-matrix: stale 'M2-in-progress' vocabulary gone; the rows the 15 gates prove now say VERIFIED-in-VM and name the gate; af-to is now an explicit non-goal row (INET6 0 in this build). - guide: the queues/divert/pflog sections described a state that no longer exists (priq-only, divert dropping packets, pflog logging nothing); they now describe the shipped behaviour. - vm-lab: the 15 real gates with what each proves, 15/15 green, and the pf0 -> cli/srv/gw2 ssh setup the screencasts rely on. - install/build: pdivert and pflogd are built and ported (docs said otherwise); module object list now includes hfsc.c, fq_codel.c, pfk_pflog.c; the screencast pipeline is an optional build stage. - pf-guide: the 'M2 scope only' framing is gone; honest gaps listed. - caveats: three new sections about the screencast pipeline (MiniMax video generation blocked by the account tier, narration as a separate track, a video frame is not a verdict). - porting-notes: what the recording taught us. - README/README.pt-BR: status, milestones, layout and video section updated. All internal doc links verified.
This commit is contained in:
1 parent
cc67531602
commit
dff2185b20
37 files changed
+677
-1616
No files matched your search
@@ -1030,3 +1030,28 @@ The port now vendors OpenBSD's `net/hfsc.h` and `net/fq_codel.h` into
|
||||
compile against one definition. Rule for anything else in this area: if a
|
||||
struct crosses the ioctl boundary, take the header from OpenBSD's tree - do not
|
||||
reconstruct it.
|
||||
|
||||
## Screencast pipeline: what the recording taught us (2026-11-12)
|
||||
|
||||
Not a compat-layer deviation, but the same kind of note - the things that
|
||||
only show up when you watch the thing run:
|
||||
|
||||
1. **The tty echo is the terminal, and readline fights it.** With bash's
|
||||
default line editing, the remote tty echoes every keystroke *and*
|
||||
readline redraws the line when you press enter, so the command appeared
|
||||
twice on screen. `bash --noediting` leaves the tty echo alone and the
|
||||
command shows exactly once.
|
||||
2. **`pfctl -e` prints "pf enabled" and so does the `echo` after it.** What
|
||||
looked like a duplicated output line was two different programs saying the
|
||||
same thing; the capture was right.
|
||||
3. **MiniMax returns the audio as a hex string**, not base64 - the payload
|
||||
starts with the ASCII of the ID3 header (`49443304`). Decoding it as
|
||||
base64 produced files that ffmpeg called "Header missing".
|
||||
4. **Pacing has to be driven by the narration.** If the voice for a beat is
|
||||
longer than the beat, the audio runs over the next action. The recorder now
|
||||
holds each beat for as long as the longest segment (EN or PT) needs, so one
|
||||
capture serves both languages.
|
||||
5. **A phase that runs `rmmod` can break another recording.** The activation
|
||||
phase unloads the module on purpose; running two captures at once left the
|
||||
routing phase without `/dev/pf` mid-session. `record.py --ensure-pf` now
|
||||
makes sure the module is in place before the capture starts.
|
||||
Reference in new issue
Block a user