Skip to content

Journal: 'Good, But' + repository structure for contributors - #433

Merged
engmung merged 7 commits into
mainfrom
dev
Sep 14, 2026
Merged

engmung merged 7 commits into
mainfrom
dev

Conversation

@engmung

@engmung engmung commented Sep 13, 2026 •

Copy link
Copy Markdown
Owner

Two things ride this PR: the journal post that opened it, and the repository-structure pass that landed on dev after it.

Journal

New journal post — good-but (ko + en), published 2026-09-13.

The campaign jumped from 75% to 132% when Crowd Supply's wholesale order landed, which met the goal but left the author feeling it wasn't earned. Also: the first artist edition, a signed unit going to the USER EXPERIENCE pop-up in San Francisco at $500, why spending the grant on campaign ads no longer adds up, and Instagram and Discord going quiet despite the GPT Astra patterns.

Two images: the funded campaign page (also the cover/OG image), and three GPT Astra patterns joined into one strip (1952×1280, 42 KB, nearest-neighbour so the pixel grid stays sharp). Verified against the dev server: both language versions return 200 with both figures. No highlight set.

Repository structure

The repository explains itself to a newcomer without moving any file that the site, the firmware or the release notes link to.

  • Entry points. CONTRIBUTING.md is one table: what you have → where it goes → what CI runs on it, plus the fork flow and the firmware pre-PR list. docs/REPOSITORY.md is the folder-by-folder map for people. SUPPORT.md, CODE_OF_CONDUCT.md, SECURITY.md, CITATION.cff, a root LICENSE pointer (GitHub reported the whole tree as CC-BY-SA), a root CLAUDE.md shim, .editorconfig.
  • Every contributor-facing subtree has a README: tools/, integrations/, firmware/modules/, firmware/toolchain/, both presets/, hardware/case/legacy_lasercut/. hardware/README.md is rewritten around one board table (v3.9 current).
  • Community surfaces. hardware/case/remixes/ for enclosure variants, README-as-licence, checked by a one-step workflow (which also checks every integration names a contract). A "Share your build" issue form replaces the Discussion template nobody could open.
  • Contracts. docs/mqtt-spec.md beside OSC and MIDI, lifted from core_mqtt.h's header and rest-api.md.
  • Dead pointers removed: GitHub Discussions links (never enabled), pattern pull-request invitations (patterns go from the Pattern Lab to the Community), the Workshop as a venue, .agents/, release.yml, the three thin docs/assembly/ sub-pages, the stale layer_stack module fixture; _ctor_probe moves to toolchain/tests/.
  • Stale facts fixed in place: the assembly map, hardware/README.md, BUILD_GUIDE.md and AGENTS.md name the v3.9 board; firmware/README.md gets a reading-order table and stops teaching the console pause that ended in 3.6.3; the Ableton bridge and BUILD_GUIDE say "install the Audio edition" instead of "rebuild with OSC"; CUSTOM_PATTERNS.md names PlatformIO and presets/; the shelf's rules link EDITIONS.md instead of the historical RFC.

Tested

check_links.py (487 links), check_boundaries.py, check_sources.py, check_versions.py all green locally. Firmware changes are comments only; web changes are one href string, one comment and the journal post.

🤖 Generated with Claude Code

New post (ko+en): the campaign jumping from 75% to 132% on Crowd
Supply's wholesale order and the bruised pride that came with it, the
first artist edition going to a San Francisco pop-up at $500, why
advertising the campaign no longer makes sense, and Instagram going
quiet despite the GPT Astra patterns.

Two images: the funded campaign page (also the cover), and the three
Astra patterns joined into one strip at an exact half scale so the
pixel grid stays crisp.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 13, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
pattern-flow-open Ready Ready Preview Sep 14, 2026 12:45am UTC

engmung and others added 6 commits September 14, 2026 03:39
… invitations removed

Adds LICENSE (pointer to both licences so GitHub stops reporting the whole
tree as CC-BY-SA), SUPPORT.md, CODE_OF_CONDUCT.md (the manifesto's sixth
section), SECURITY.md, CITATION.cff, a root CLAUDE.md shim, .editorconfig
and a 'Share your build' issue form that replaces the Discussion template
nobody could open. Discussions stays off, so README no longer points there.
Patterns are published from the Pattern Lab to the Community, not sent as
pull requests; CUSTOM_PATTERNS, CONTRIBUTING and the PR template now say so.
Historical banners on docs/releases/, four stale one-liners fixed, unused
release.yml removed.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…xes for tools/ and integrations/

CONTRIBUTING.md is rewritten around one table: what you have, where it
goes, what CI runs on it, plus the fork flow, the firmware pre-PR list and
the hard rules that used to live only in AGENTS.md. docs/REPOSITORY.md is
the folder-by-folder map for people; docs/README.md gains Walk-throughs,
Contributing and a pointer to it. README's Docs line is grouped into
Build / Play / Extend / Project and its firmware pointer now lands on the
firmware build doc. The dev->main routine moves to RELEASING.md. tools/ and
integrations/ get index READMEs that state the boundary between them; the
Ableton bridge says 'install the Audio edition' instead of 'rebuild with
OSC'. CUSTOM_PATTERNS' local route now names PlatformIO and presets/.
.agents/ is gone; a root CLAUDE.md shim points agents at AGENTS.md.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…face

Every contributor-facing subtree now explains itself: firmware/modules/
(the module toolchain's working folder, not an inbox), firmware/toolchain/,
both presets/ folders, hardware/case/legacy_lasercut/. docs/mqtt-spec.md
lifts the MQTT contract out of core_mqtt.h's header comment and rest-api.md
so it sits beside the OSC and MIDI contracts. hardware/case/remixes/ is the
named place for community enclosure variants, with a README-as-licence rule
and a one-step workflow that checks it (and that every integration names a
contract). The loader's ctor probe moves out of modules/ into
toolchain/tests/, and the stale layer_stack fixture (author unknown, source
path gone) is removed. The shelf's rules now point at EDITIONS.md instead of
the historical RFC. The Workshop is no longer offered as a venue.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… teaching what 3.6.3 ended

hardware/README.md is rewritten around one board table (v3.9 current, v3.0
previous, v2.1 legacy) that says which Gerber, BOM and case to take, and
lists every subfolder. The assembly map stops pointing builders at the
v3.0.0 release bundle and drops its three thin sub-pages, which restated
the hardware READMEs and had already drifted. BUILD_GUIDE names the v3 board
rather than v3.0.0 and sends OSC/MIDI users to the Audio edition instead of
a rebuild. RELEASING gains the hardware-change checklist; CHANGELOG records
the v3.9 revision under Unreleased.

firmware/README.md gets a reading-order table at the top, loses the
console-pause behaviour it taught in three places (ended in 3.6.3), the
verbatim OSC address list and audio message format that live in the
contracts, the pre-console/ page workflow, and the 'possible next steps'
stub; its measurement tables now say which build they were taken on, the
runtime paragraphs that had been pasted under the PFCanvas heading get
their own, and the audio/OSC flags are named where they actually live.
features/README documents the SELECT hooks and audio_in; pf_feature.h's
header points at the bundle file, not features.h. AUDIO_GUIDE's MIDI
section shrinks to two paragraphs and links.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…es move

A renamed STL or Gerber zip breaks a guide's link exactly as a renamed page
does, but the check only ran on Markdown changes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The Workshop on the community site is not where project talk happens;
Discord is. A discussion venue that works where Discord is blocked is
planned separately.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@engmung engmung changed the title Journal: new post 'Good, But' Journal: 'Good, But' + repository structure for contributors Sep 14, 2026
@engmung
engmung merged commit 627862d into main Sep 14, 2026
8 checks passed

This branch was successfully deployed

1 active deployment
Preview – pattern-flow-open — eb512b84 Deployed Sep 14, 2026 by vercel[bot]
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.

1 participant