Skip to content

Publishing checklist

Status: firmware v0.9.7 (Wispr-style screens, updates keep the pairing); housing v2 printed, test-fitted and released as-is. Any screen change: run tools/sim/run.sh to regenerate the docs images from the firmware. The housing lives in WOODWERD/cyd-case since 2026-10-23; housing changes go there.

This folder is a ready-to-push GitHub repository. Steps, in order.

1. The repo and the docs site

  • Repo: https://github.com/WOODWERD/cyd-flow-ctrl (public; created 2026-09-16).
  • Docs site: https://woodwerd.github.io/cyd-flow-ctrl/ — built from docs/ by .github/workflows/pages.yml (MkDocs Material) on every push to main. The workflow reuses the README as the home page and the notices file, so there is one copy of every document. docs/flash/ is an ESP Web Tools page that flashes release/*.bin from Chrome in one click.
  • Settings → Pages → Source is GitHub Actions (set by hand 2026-09-16 — GitHub only allows it once the repo has content, and the workflow token can't set it).
  • Day to day: edit, commit and push with GitHub Desktop (the folder is added there) or git push from a terminal. Each push rebuilds the site in about a minute; check the Actions tab if it doesn't.

Repo description: Push-to-talk / hands-free button for Wispr Flow on the ESP32 Cheap Yellow Display, with a printed case. Topics worth adding: esp32, cheap-yellow-display, cyd, wispr-flow, ble-hid, lvgl, 3d-printing.

2. Make a release

Tag the version (currently v0.9.7) and attach from release/: the full images flow-ctrl-v0.9.7-cyd2usb-mac.bin / -win.bin (new boards, 0x0) and the update images …-mac-update.bin / …-win-update.bin (0x10000, keep the pairing) — and a cyd build if you make one — so people can flash without cloning. Keep them in release/ too: the README links to them and the Flash page serves them (tools/merge.sh produces all of them, plus the bootloader / partitions / boot_app0 pieces the Flash page needs).

3. Add it to the CYD project list

The CYD repo lists community projects in PROJECTS.md and asks that you add your own by PR at the bottom of the table (open source + functional are the only requirements). Fork witnessmenow/ESP32-Cheap-Yellow-Display, append this row, open the PR:

| Flow Ctrl | Push-to-talk / hands-free button for Wispr Flow dictation — the CYD pairs as a Bluetooth keyboard; includes a printed case | WOODWERD LLC | None | [Github](https://github.com/WOODWERD/cyd-flow-ctrl) | |

Adjust the column order to whatever the table has when you get there (Name · Description · Author · Additional Hardware? · Project Page · WebFlash). The case can also be offered as a line under "Other cases from elsewhere" in 3dModels/README.md pointing at cyd-case, if you'd like it findable from there too — that list already links out to Printables/MakerWorld/GitHub.

4. Optional: web flasher

The CYD list has a WebFlash column. A GitHub Pages site with ESP Web Tools and a manifest.json pointing at the merged bin is an afternoon's work and lets people flash from Chrome with one click; the Feeder-panel-style esptool-js route works but needs the user to type the address.

5. Optional: Printables / MakerWorld

This now belongs to cyd-case: upload housings/v2/*.stl with its renders and the text of housings/v2/README.md, and link to the firmware repos from there. License choice there: CC-BY-4.0 is the usual pick for models (MIT is fine too; just be consistent with the repo).

Before pushing — things checked already

  • No personal paths, serial-port names, or unrelated project references in the tree.
  • Getting Started / Build guides and their images regenerate from tools/make_guide.py — rerun after any screen change so the pictures match the firmware.
  • Fonts carry their OFL licence files; third-party libraries listed with licences.
  • Wispr trademark disclaimer present; no Wispr artwork or code included.
  • CYD board CAD (MIT) is referenced, not redistributed.
  • BLE manufacturer string is "WOODWERD LLC", matching the LICENSE and README attribution.