Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ The interactive guide at [patternflow.work/guide](https://patternflow.work/guide
- [`RELEASING.md`](RELEASING.md) — the `dev` → `main` routine, cutting a release, what the workflows attach
- [`SERVICES.md`](SERVICES.md) — the production hosts (community, build worker) and their systemd units. Korean.

## Drafts — Part 2 only, and nothing in them is built

- [`rfc-any-resolution.md`](rfc-any-resolution.md) — a panel of another size on one ESP32-S3, chosen on a console page and applied at the next boot instead of in a rebuild. Classic HUB75 only, within the driver's DMA memory
- [`rfc-linux-player.md`](rfc-linux-player.md) — the site's pattern engine as a Linux program, onto a HUB75 HAT on a Raspberry Pi, a receiving card or a screen. Not firmware, and not an edition

## Records

- [`investigations/`](investigations/) — dated post-mortems, and the cleanup's plans. `npm run doc-map` in `web/` writes the two lists here: `2026-10-doc-map.csv`, every link in the tree and whether it resolves, and `2026-10-doc-parity.csv`, every Korean/English pair and which side is missing or short
Expand Down
20 changes: 20 additions & 0 deletions docs/investigations/2026-10-doc-map.csv
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,10 @@ docs/README.md,docs/pfst-v2-spec.md,relative,,yes
docs/README.md,docs/pfst-v2-vectors,relative,,yes
docs/README.md,docs/releases,relative,,yes
docs/README.md,docs/rest-api.md,relative,,yes
docs/README.md,docs/rfc-any-resolution.md,relative,,yes
docs/README.md,docs/rfc-core-and-variants-progress.md,relative,,yes
docs/README.md,docs/rfc-core-and-variants.md,relative,,yes
docs/README.md,docs/rfc-linux-player.md,relative,,yes
docs/README.md,docs/voice-banned.txt,relative,,yes
docs/README.md,docs/voice.md,relative,,yes
docs/README.md,firmware/CUSTOM_PATTERNS.md,relative,,yes
Expand Down Expand Up @@ -367,6 +369,8 @@ docs/investigations/2026-10-cleanup-step4-plan.md,docs/voice.md,relative,,yes
docs/investigations/2026-10-cleanup-step5-plan.md,docs/panel-compatibility.md,relative,,yes
docs/investigations/2026-10-cleanup-step5-plan.md,docs/rfc-cleanup.md,relative,,yes
docs/investigations/2026-10-cleanup-step5-plan.md,docs/voice.md,relative,,yes
docs/investigations/2026-10-panel-geometry.md,docs/investigations/2026-10-cleanup-step5-plan.md,relative,,yes
docs/investigations/2026-10-panel-geometry.md,docs/rfc-cleanup.md,relative,,yes
docs/legacy/BUILD_GUIDE_v2.md,/,site,,yes
docs/legacy/BUILD_GUIDE_v2.md,/build/breadboard,site,,yes
docs/legacy/BUILD_GUIDE_v2.md,BUILD_GUIDE.md,relative,,yes
Expand Down Expand Up @@ -458,6 +462,11 @@ docs/rest-api.md,docs/audio-ws-spec.md,relative,,yes
docs/rest-api.md,docs/audio-ws-spec.md,relative,the-switch-on-the-panel,yes
docs/rest-api.md,docs/midi-spec.md,relative,,yes
docs/rest-api.md,docs/mqtt-spec.md,relative,,yes
docs/rfc-any-resolution.md,docs/investigations/2026-08-core2-heap-and-the-5s-stall.md,relative,,yes
docs/rfc-any-resolution.md,docs/investigations/2026-10-panel-geometry.md,relative,,yes
docs/rfc-any-resolution.md,docs/panel-compatibility.md,relative,9-why-hub75e-guarantees-nothing-and-the-three-tiers,yes
docs/rfc-any-resolution.md,docs/rfc-cleanup.md,relative,212-order-and-what-done-means,yes
docs/rfc-any-resolution.md,docs/rfc-linux-player.md,relative,a-receiving-card,yes
docs/rfc-cleanup-progress.md,docs/investigations/2026-10-cleanup-baseline.md,relative,,yes
docs/rfc-cleanup-progress.md,docs/investigations/2026-10-cleanup-step1-plan.md,relative,,yes
docs/rfc-cleanup-progress.md,docs/investigations/2026-10-cleanup-step2-plan.md,relative,,yes
Expand All @@ -476,6 +485,17 @@ docs/rfc-core-and-variants.md,docs/EDITIONS.md,relative,,yes
docs/rfc-core-and-variants.md,docs/pfst-v2-spec.md,relative,,yes
docs/rfc-core-and-variants.md,docs/rfc-core-and-variants-progress.md,relative,,yes
docs/rfc-core-and-variants.md,docs/rfc-core-and-variants-progress.md,relative,what-the-slim-core-measures,yes
docs/rfc-linux-player.md,docs/EDITIONS.md,relative,the-three-words,yes
docs/rfc-linux-player.md,docs/audio-ws-spec.md,relative,,yes
docs/rfc-linux-player.md,docs/investigations/2026-10-cleanup-step4-plan.md,relative,,yes
docs/rfc-linux-player.md,docs/investigations/2026-10-panel-geometry.md,relative,the-site,yes
docs/rfc-linux-player.md,docs/midi-spec.md,relative,,yes
docs/rfc-linux-player.md,docs/mqtt-spec.md,relative,,yes
docs/rfc-linux-player.md,docs/osc-spec.md,relative,,yes
docs/rfc-linux-player.md,docs/panel-compatibility.md,relative,,yes
docs/rfc-linux-player.md,docs/rest-api.md,relative,,yes
docs/rfc-linux-player.md,docs/rfc-any-resolution.md,relative,,yes
docs/rfc-linux-player.md,docs/rfc-cleanup.md,relative,,yes
docs/voice.md,AGENTS.md,relative,,yes
docs/voice.md,BUILD_GUIDE.md,relative,,yes
docs/voice.md,README.md,relative,,yes
Expand Down
2 changes: 1 addition & 1 deletion docs/rfc-any-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ Classic HUB75 only, tiers 1 and 2 in
S-PWM panels (ICN2053, FM6353, MBI5051 and the rest) stay dark at any
geometry. They need a grey-scale clock the driver cannot make (upstream issue
642, closed wontfix; `config.h:153-160`), and they are built for a receiving
card, which is an output of the player in `docs/rfc-linux-player.md`.
card, which is an output of the player in [rfc-linux-player.md §2.3](rfc-linux-player.md#a-receiving-card).

One chain, in a row, two rows lit at once
(`ESP32-HUB75-MatrixPanel-I2S-DMA.h:67, 750-751`): a module is 32 or 64 tall.
Expand Down
2 changes: 1 addition & 1 deletion docs/rfc-linux-player.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ HUB75 HAT is the first machine it is written for. It is not firmware and not
an edition: an edition is a firmware build
([EDITIONS.md](EDITIONS.md#the-three-words)), and nothing here compiles for
the ESP32-S3.
The firmware path, any size on one ESP32-S3, is `docs/rfc-any-resolution.md`.
The firmware path, any size on one ESP32-S3, is [rfc-any-resolution.md](rfc-any-resolution.md).

Facts are from `dev` at `adbe923`. Where the player leans on work that is only
planned, the plan and its k are named and the paths are in backticks. "Size" is
Expand Down
Loading