Skip to content

docs, web: the first flash starts in download mode everywhere, /flash goes to the guide, and the README is rewritten - #492

Merged
engmung merged 3 commits into
engmung:mainfrom
Patternflow-lab:claude/patternflow-upstream-docs-r4eab8
Oct 12, 2026
Merged

engmung merged 3 commits into
engmung:mainfrom
Patternflow-lab:claude/patternflow-upstream-docs-r4eab8

Conversation

@patternflow-bot

Copy link
Copy Markdown
Contributor

What

Three commits that bring the first-flash steps into one order across the site and the docs, and rewrite the README:

  1. web, docs: The Play guide's 01 Flash (and /ko) starts in download mode on every first flash (hold BOOT, tap RST, let go), expects the Wi-Fi step after "Installation complete!" not to come (RST, Flash Patternflow again, Connect to Wi-Fi), and ends on the panel's own patternflow-xxxx network at 192.168.4.1 when that does not take; the device simulator draws the NETWORK screen's hotspot. The Build guide's flash card, the Pattern tab's notes and the breadboard page say the same thing. The bare /flash redirects to /guide/play#flash; /flash/manifest.json and /flash/bin/* are untouched. The docs that give the first flash (firmware/README.md, PATTERN_GUIDE.md, SUPPORT.md, docs/assembly/) use the same order, the indexes list the guide pages, the three case remixes and the bundles that exist, CONTRIBUTING gets a row for the interactive guide's copy, and the PR template asks which row a change is.
  2. docs: The README opens with the manifesto's fixed lines (L1–L3) and three ways in (try it in the browser, build one, get one assembled). Paik is told once, in Where it began. First light comes after the build, with the steps it was missing: unplug before seating the DevKit, Origin as the sign of success, Format storage on the first Basics install. Stale lines are corrected against the repo.
  3. docs: BUILD_GUIDE.md §8.1 follows the Play guide's Flash chapter step by step. §7 no longer seats the DevKit before it has firmware, so it is Wiring (#7-wiring), and Besoiobiy's case README cites the renumbered steps. The README's Crowd Supply lines read as the campaign stands: past its goal and open until 15 October.

Why

The guide, the README, BUILD_GUIDE and the site each gave a different first flash. Download mode was a fallback for an empty port list, though every first flash needs it. The Wi-Fi step was described as if it always comes, though it usually doesn't after a download-mode install. The panel's own hotspot was missing. And /flash, which the device's Update page and every release's FLASHING.md point at, had no page. The README buried the way in under the story.

Tested

  • web/: npm ci, npm run lint (0 errors; the changed files show the same 5 no-img-element warnings they have on main), npm run typecheck, npm run build, npm run check:ci (vitest 35 files / 478 tests, including the new flash.test.ts, plus every smoke suite). All pass.
  • next start: /flash returns 307 to /guide/play#flash; /flash/manifest.json and /guide/play return 200.
  • python3 .github/scripts/check_links.py: all 623 relative links resolve.
  • firmware/ changes are README text only (no code). check_boundaries.py and check_presets.py pass anyway.

Which row

A fix to a guide, a README or a spec (docs-links), and a fix to the interactive guide (web-ci).

Where it comes from

Prepared in the Patternflow-lab workshop fork at @engmung's request, one commit per fork PR (screenshots of each change are in those PRs):


  • Touches web/ → it builds (npm run build)
  • Touches firmware/ → README text only; the core still names no feature (python firmware/toolchain/check_boundaries.py)
  • Touches a markdown file → its relative links resolve (python3 .github/scripts/check_links.py)

🤖 Generated with Claude Code

…e guide's Flash chapter, and the README is new from its first screen

The Play guide's 01 Flash (and /ko) puts hold BOOT, tap RST before Flash
Patternflow on every first flash, assumes the Wi-Fi step after
"Installation complete!" usually does not come (RST, Flash Patternflow
again, Connect to Wi-Fi), and ends on the panel's own patternflow-xxxx
network at 192.168.4.1 for when that does not take; the device simulator
draws the NETWORK screen's hotspot. The Build guide's flash card, the
Pattern tab's notes and the breadboard page give the same order. The bare
/flash, which the device's Update page and every release's FLASHING.md
point at, redirects to /guide/play#flash; /flash/manifest.json and
/flash/bin/* are untouched. flash.test.ts pins the card order and anchors.

The README opens with a one-line definition, the hero, the
photosensitivity warning, four doors (Build, Play, Make patterns, Add
sound) and First light; the story, community, facts and editions follow,
shorter. The docs that give the first flash (firmware/README.md,
PATTERN_GUIDE.md, SUPPORT.md, docs/assembly/) say the same order, the
indexes list the guide pages, the three case remixes and the bundles that
exist, and stale wording (the custom slots, "variant", the dead /flash
page) is gone. CONTRIBUTING.md gets a row for the interactive guide's
copy, and the pull request template asks for the row and the link check.

From #7 (caaf2c1).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VaFtEmtx2AkdH1wnbQpV3Z
…rst light follows the build

The opening is L1 + L2 + L3 from docs/manifesto.md (Paik moves to Where it
began, in L5's own words), with Play one in your browser, Build one and Get
one assembled under the badges. First light moves below the build, gains the
steps it was missing (unplug before seating, Origin as the sign of success,
Format storage on the first Basics install) and states the J4 rule as data
never power on the DevKit's ports. Stale lines are corrected against the
repo: sound and MQTT shipped in editions, MIDI arrived in 3.9.0, 3.10.5
fixed four requests, and the photosensitivity warning is the manifesto's
full text.

From #8 (bfc4b22).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VaFtEmtx2AkdH1wnbQpV3Z
… campaign is still open

BUILD_GUIDE §8.1 now goes download mode first (hold BOOT, tap RST),
Flash Patternflow, the Wi-Fi as a second go after RST, the DevKit seated
with the power bank unplugged, then the panel's own patternflow-xxxx
network (K2 shows its name before the hotspot is up), then the Basics
pack: the Play guide's 01 Flash card for card. §7 no longer seats the
DevKit before it has firmware, so it is Wiring, and 7.4 names the step
that powers up. The README's First light points at §8 again, and Crowd
Supply reads as it stands: past its goal, open until 15 October; the
200% figure stays in the dated timeline. Besoiobiy's case README cites
the renumbered steps.

From #9 (16eca1b).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VaFtEmtx2AkdH1wnbQpV3Z
@vercel

vercel Bot commented Oct 12, 2026

Copy link
Copy Markdown

@claude is attempting to deploy a commit to the engmung's projects Team on Vercel.

A member of the Team first needs to authorize it.

@patternflow-bot
patternflow-bot deleted the claude/patternflow-upstream-docs-r4eab8 branch October 12, 2026 12:50
@patternflow-bot
patternflow-bot restored the claude/patternflow-upstream-docs-r4eab8 branch October 12, 2026 12:50
@engmung engmung reopened this Oct 12, 2026
@engmung
engmung merged commit a5cbba9 into engmung:main Oct 12, 2026
20 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants