From 346ed4ff9fef3c7f498dfec39d3a80128b1cd181 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 15 Oct 2026 00:06:22 +0000 Subject: [PATCH 1/3] =?UTF-8?q?=EC=8B=9C=EC=9E=91=20=E2=80=94=20=EC=A0=95?= =?UTF-8?q?=EB=A6=AC=201=EB=8B=A8=EA=B3=84=20PR=20C3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01S5utCYhZ1dCRVsV4UgD716 From 6ded2af67ef3e9da10624341034315ac971a3883 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 15 Oct 2026 00:09:07 +0000 Subject: [PATCH 2/3] docs: regenerate the doc map after step 1's moves Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01S5utCYhZ1dCRVsV4UgD716 --- docs/investigations/2026-10-doc-map.csv | 182 +++++++++++++++--------- 1 file changed, 115 insertions(+), 67 deletions(-) diff --git a/docs/investigations/2026-10-doc-map.csv b/docs/investigations/2026-10-doc-map.csv index 9b1f3594..11902b10 100644 --- a/docs/investigations/2026-10-doc-map.csv +++ b/docs/investigations/2026-10-doc-map.csv @@ -1,36 +1,27 @@ from,to,kind,anchor,resolves +.github/CODE_OF_CONDUCT.md,.github/SECURITY.md,relative,,yes +.github/CODE_OF_CONDUCT.md,docs/manifesto.md,relative,6-how-we-treat-each-other,yes .github/FUNDING.yml,/,site,,yes +.github/ISSUE_TEMPLATE/config.yml,.github/SUPPORT.md,absolute-blob,,yes .github/ISSUE_TEMPLATE/config.yml,CONTRIBUTING.md,absolute-blob,,yes -.github/ISSUE_TEMPLATE/config.yml,SUPPORT.md,absolute-blob,,yes .github/ISSUE_TEMPLATE/docs_issue.yml,/build,site,,yes .github/ISSUE_TEMPLATE/share_build.yml,/inside,site,,yes .github/ISSUE_TEMPLATE/share_build.yml,CONTRIBUTING.md,absolute-blob,your-build,yes .github/PULL_REQUEST_TEMPLATE.md,CONTRIBUTING.md,absolute-blob,where-your-contribution-goes,yes +.github/SECURITY.md,/editions,site,,yes +.github/SECURITY.md,/pattern,site,,yes +.github/SECURITY.md,/update,site,,yes +.github/SECURITY.md,docs/rest-api.md,relative,transport,yes +.github/SUPPORT.md,.github/SECURITY.md,relative,,yes +.github/SUPPORT.md,/guide,site,,yes +.github/SUPPORT.md,/guide/play,site,flash,yes +.github/SUPPORT.md,/inside,site,,yes +.github/SUPPORT.md,/pattern,site,,yes +.github/SUPPORT.md,/pattern-lab,site,,yes +.github/SUPPORT.md,BUILD_GUIDE.md,relative,8-firmware,yes +.github/SUPPORT.md,CONTRIBUTING.md,relative,,yes AGENTS.md,docs/EDITIONS.md,relative,,yes AGENTS.md,docs/rfc-cleanup.md,relative,,yes -AUDIO_GUIDE.md,/editions,site,,yes -AUDIO_GUIDE.md,/guide/audio,site,,yes -AUDIO_GUIDE.md,AGENTS.md,relative,hard-rules-do-not-violate,yes -AUDIO_GUIDE.md,BUILD_GUIDE.md,relative,8-firmware,yes -AUDIO_GUIDE.md,CONTRIBUTING.md,relative,,yes -AUDIO_GUIDE.md,FEATURE_GUIDE.md,relative,,yes -AUDIO_GUIDE.md,docs/audio-ws-spec.md,relative,,yes -AUDIO_GUIDE.md,docs/director-midi.md,relative,,yes -AUDIO_GUIDE.md,docs/images/audio-guide/pdm-mic-wiring.jpg,relative,,yes -AUDIO_GUIDE.md,docs/midi-ableton.md,relative,,yes -AUDIO_GUIDE.md,docs/midi-spec.md,relative,,yes -AUDIO_GUIDE.md,docs/osc-spec.md,relative,,yes -AUDIO_GUIDE.md,docs/rest-api.md,relative,,yes -AUDIO_GUIDE.md,docs/rest-api.md,relative,microphone-audio-edition,yes -AUDIO_GUIDE.md,firmware/patternflow/console/README.md,relative,the-page-that-is-assembled-audio-in,yes -AUDIO_GUIDE.md,firmware/patternflow/features/audio,relative,,yes -AUDIO_GUIDE.md,firmware/patternflow/features/audio_in,relative,,yes -AUDIO_GUIDE.md,firmware/patternflow/features/midi,relative,,yes -AUDIO_GUIDE.md,integrations/ableton,relative,,yes -AUDIO_GUIDE.md,tools/patternflow-audio-android,relative,,yes -AUDIO_GUIDE.md,tools/patternflow-audio-android/README.md,relative,,yes -AUDIO_GUIDE.md,tools/patternflow-audio-extension,relative,,yes -AUDIO_GUIDE.md,tools/patternflow-audio-extension/README.md,relative,,yes BUILD_GUIDE.md,/,site,,yes BUILD_GUIDE.md,/editions,site,,yes BUILD_GUIDE.md,/guide/build,site,,yes @@ -66,28 +57,44 @@ CHANGELOG.md,/guide,site,,yes CHANGELOG.md,/guide/build,site,,yes CHANGELOG.md,/guide/make,site,,yes CHANGELOG.md,/guide/play,site,,yes -CHANGELOG.md,/panel-tuner.html,site,,yes -CHANGELOG.md,/roadmap,site,,yes -CHANGELOG.md,/update,site,,yes -CHANGELOG.md,/variants,site,,yes -CHANGELOG.md,BUILD_GUIDE.md,relative,,yes -CHANGELOG.md,docs/investigations/2026-08-core2-heap-and-the-5s-stall.md,relative,,yes -CHANGELOG.md,docs/investigations/2026-08-the-panel-clock-and-the-wifi-radio.md,relative,,yes -CHANGELOG.md,docs/investigations/2026-09-firmware-runtime.md,relative,,yes -CHANGELOG.md,docs/panel-compatibility.md,relative,,yes -CHANGELOG.md,docs/pfst-v2-spec.md,relative,,yes -CODE_OF_CONDUCT.md,SECURITY.md,relative,,yes -CODE_OF_CONDUCT.md,docs/manifesto.md,relative,6-how-we-treat-each-other,yes +CHANGELOG.md,docs/releases,relative,,yes +CHANGELOG.md,docs/releases/v1.0.0.md,relative,,yes +CHANGELOG.md,docs/releases/v1.1.0.md,relative,,yes +CHANGELOG.md,docs/releases/v2.0.0.md,relative,,yes +CHANGELOG.md,docs/releases/v2.1.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.0.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.1.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.10.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.10.1.md,relative,,yes +CHANGELOG.md,docs/releases/v3.10.2.md,relative,,yes +CHANGELOG.md,docs/releases/v3.10.3.md,relative,,yes +CHANGELOG.md,docs/releases/v3.2.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.3.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.4.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.4.9.md,relative,,yes +CHANGELOG.md,docs/releases/v3.5.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.5.1.md,relative,,yes +CHANGELOG.md,docs/releases/v3.5.2.md,relative,,yes +CHANGELOG.md,docs/releases/v3.6.3.md,relative,,yes +CHANGELOG.md,docs/releases/v3.7.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.7.1.md,relative,,yes +CHANGELOG.md,docs/releases/v3.8.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.9.0.md,relative,,yes +CHANGELOG.md,docs/releases/v3.9.1.md,relative,,yes +CHANGELOG.md,docs/releases/v3.9.2.md,relative,,yes +CHANGELOG.md,docs/releases/v3.9.3.md,relative,,yes +CHANGELOG.md,docs/releases/v3.9.4.md,relative,,yes +CHANGELOG.md,docs/releases/v3.9.5.md,relative,,yes +CONTRIBUTING.md,.github/CODE_OF_CONDUCT.md,relative,,yes +CONTRIBUTING.md,.github/SUPPORT.md,relative,,yes CONTRIBUTING.md,/guide,site,,yes CONTRIBUTING.md,/inside,site,,yes CONTRIBUTING.md,/pattern-lab,site,,yes CONTRIBUTING.md,AGENTS.md,relative,hard-rules-do-not-violate,yes -CONTRIBUTING.md,CODE_OF_CONDUCT.md,relative,,yes CONTRIBUTING.md,FEATURE_GUIDE.md,relative,,yes CONTRIBUTING.md,LICENSE-CC-BY-SA,relative,,yes CONTRIBUTING.md,LICENSE-MIT,relative,,yes CONTRIBUTING.md,PATTERN_GUIDE.md,relative,,yes -CONTRIBUTING.md,SUPPORT.md,relative,,yes CONTRIBUTING.md,docs/EDITIONS.md,relative,,yes CONTRIBUTING.md,docs/LICENSE-SUMMARY.md,relative,,yes CONTRIBUTING.md,docs/RELEASING.md,relative,,yes @@ -142,6 +149,7 @@ PATTERN_GUIDE.md,docs/images/pattern-guide/15-convert-header.png,relative,,yes PATTERN_GUIDE.md,docs/images/pattern-guide/16-on-to-hardware.png,relative,,yes PATTERN_GUIDE.md,docs/images/pattern-guide/17-send-over-wifi.png,relative,,yes PATTERN_GUIDE.md,docs/images/pattern-guide/18-publish.png,relative,,yes +README.md,.github/SUPPORT.md,relative,,yes README.md,/,site,,yes README.md,/build/breadboard,site,,yes README.md,/contact,site,,yes @@ -159,7 +167,6 @@ README.md,/inside,site,,yes README.md,/journal,site,,yes README.md,/pattern,site,,yes README.md,/pattern-lab,site,,yes -README.md,AUDIO_GUIDE.md,relative,,yes README.md,BUILD_GUIDE.md,relative,,yes README.md,BUILD_GUIDE.md,relative,1-bill-of-materials-bom,yes README.md,BUILD_GUIDE.md,relative,10-known-issues--design-notes,yes @@ -172,7 +179,7 @@ README.md,FEATURE_GUIDE.md,relative,,yes README.md,LICENSE-CC-BY-SA,relative,,yes README.md,LICENSE-MIT,relative,,yes README.md,PATTERN_GUIDE.md,relative,,yes -README.md,SUPPORT.md,relative,,yes +README.md,docs/AUDIO_GUIDE.md,relative,,yes README.md,docs/EDITIONS.md,relative,,yes README.md,docs/LICENSE-SUMMARY.md,relative,,yes README.md,docs/README.md,relative,,yes @@ -210,18 +217,29 @@ README.md,integrations/ableton,relative,,yes README.md,tools/patternflow-audio-extension,relative,,yes README.md,web/ARCHITECTURE.md,relative,,yes README.md,web/public/journal/v1-30-days/first-pcb.jpg,relative,,yes -SECURITY.md,/editions,site,,yes -SECURITY.md,/pattern,site,,yes -SECURITY.md,/update,site,,yes -SECURITY.md,docs/rest-api.md,relative,transport,yes -SUPPORT.md,/guide,site,,yes -SUPPORT.md,/guide/play,site,flash,yes -SUPPORT.md,/inside,site,,yes -SUPPORT.md,/pattern,site,,yes -SUPPORT.md,/pattern-lab,site,,yes -SUPPORT.md,BUILD_GUIDE.md,relative,8-firmware,yes -SUPPORT.md,CONTRIBUTING.md,relative,,yes -SUPPORT.md,SECURITY.md,relative,,yes +docs/AUDIO_GUIDE.md,/editions,site,,yes +docs/AUDIO_GUIDE.md,/guide/audio,site,,yes +docs/AUDIO_GUIDE.md,AGENTS.md,relative,hard-rules-do-not-violate,yes +docs/AUDIO_GUIDE.md,BUILD_GUIDE.md,relative,8-firmware,yes +docs/AUDIO_GUIDE.md,CONTRIBUTING.md,relative,,yes +docs/AUDIO_GUIDE.md,FEATURE_GUIDE.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/audio-ws-spec.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/director-midi.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/images/audio-guide/pdm-mic-wiring.jpg,relative,,yes +docs/AUDIO_GUIDE.md,docs/midi-ableton.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/midi-spec.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/osc-spec.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/rest-api.md,relative,,yes +docs/AUDIO_GUIDE.md,docs/rest-api.md,relative,microphone-audio-edition,yes +docs/AUDIO_GUIDE.md,firmware/patternflow/console/README.md,relative,the-page-that-is-assembled-audio-in,yes +docs/AUDIO_GUIDE.md,firmware/patternflow/features/audio,relative,,yes +docs/AUDIO_GUIDE.md,firmware/patternflow/features/audio_in,relative,,yes +docs/AUDIO_GUIDE.md,firmware/patternflow/features/midi,relative,,yes +docs/AUDIO_GUIDE.md,integrations/ableton,relative,,yes +docs/AUDIO_GUIDE.md,tools/patternflow-audio-android,relative,,yes +docs/AUDIO_GUIDE.md,tools/patternflow-audio-android/README.md,relative,,yes +docs/AUDIO_GUIDE.md,tools/patternflow-audio-extension,relative,,yes +docs/AUDIO_GUIDE.md,tools/patternflow-audio-extension/README.md,relative,,yes docs/EDITIONS.md,/editions,site,,yes docs/EDITIONS.md,PATTERN_GUIDE.md,relative,,yes docs/EDITIONS.md,docs/RELEASING.md,relative,,yes @@ -238,6 +256,7 @@ docs/EDITIONS.md,firmware/patternflow/features/README.md,relative,,yes docs/LICENSE-SUMMARY.md,/community,site,,yes docs/LICENSE-SUMMARY.md,/terms,site,,yes docs/LICENSE-SUMMARY.md,CONTRIBUTING.md,relative,,yes +docs/README.md,.github/SUPPORT.md,relative,,yes docs/README.md,/guide,site,,yes docs/README.md,/guide/audio,site,,yes docs/README.md,/guide/build,site,,yes @@ -248,7 +267,7 @@ docs/README.md,BUILD_GUIDE.md,relative,,yes docs/README.md,BUILD_GUIDE.md,relative,8-firmware,yes docs/README.md,CONTRIBUTING.md,relative,,yes docs/README.md,PATTERN_GUIDE.md,relative,,yes -docs/README.md,SUPPORT.md,relative,,yes +docs/README.md,docs/AUDIO_GUIDE.md,relative,,yes docs/README.md,docs/EDITIONS.md,relative,,yes docs/README.md,docs/LICENSE-SUMMARY.md,relative,,yes docs/README.md,docs/RELEASING.md,relative,,yes @@ -284,13 +303,13 @@ docs/REPOSITORY.md,/guide/make,site,,yes docs/REPOSITORY.md,/guide/play,site,,yes docs/REPOSITORY.md,/guide/play,site,flash,yes docs/REPOSITORY.md,AGENTS.md,relative,,yes -docs/REPOSITORY.md,AUDIO_GUIDE.md,relative,,yes docs/REPOSITORY.md,BUILD_GUIDE.md,relative,,yes docs/REPOSITORY.md,BUILD_GUIDE.md,relative,8-firmware,yes docs/REPOSITORY.md,CONTRIBUTING.md,relative,,yes docs/REPOSITORY.md,FEATURE_GUIDE.md,relative,,yes docs/REPOSITORY.md,PATTERN_GUIDE.md,relative,,yes docs/REPOSITORY.md,README.md,relative,,yes +docs/REPOSITORY.md,docs/AUDIO_GUIDE.md,relative,,yes docs/REPOSITORY.md,docs/EDITIONS.md,relative,,yes docs/REPOSITORY.md,docs/README.md,relative,,yes docs/REPOSITORY.md,docs/RELEASING.md,relative,,yes @@ -338,6 +357,10 @@ docs/investigations/2026-10-cleanup-baseline.md,docs/rfc-cleanup-progress.md,rel docs/investigations/2026-10-cleanup-baseline.md,docs/rfc-cleanup.md,relative,,yes docs/investigations/2026-10-cleanup-baseline.md,web/scripts/doc-map.ts,relative,,yes docs/investigations/2026-10-cleanup-step1-plan.md,docs/rfc-cleanup.md,relative,,yes +docs/investigations/2026-10-cleanup-step2-plan.md,docs/rfc-cleanup.md,relative,,yes +docs/investigations/2026-10-cleanup-step3-plan.md,docs/rfc-cleanup.md,relative,,yes +docs/investigations/2026-10-cleanup-step4-plan.md,docs/rfc-cleanup.md,relative,,yes +docs/investigations/2026-10-cleanup-step4-plan.md,docs/voice.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 @@ -398,17 +421,32 @@ docs/panel-compatibility.md,firmware/patternflow/config.h,relative,,yes docs/panel-compatibility.md,firmware/patternflow/src/core_display.h,relative,,yes docs/panel-compatibility.md,hardware/bom/README.md,relative,,yes docs/pfst-v2-spec.md,docs/pfst-v2-vectors,relative,,yes +docs/releases/v1.0.0.md,BUILD_GUIDE.md,relative,,yes docs/releases/v3.0.0-launch.md,docs/RELEASING.md,relative,,yes -docs/releases/v3.0.0.md,/,site,,yes -docs/releases/v3.0.0.md,BUILD_GUIDE.md,absolute-blob,2-power-input--use-the-screw-terminal,yes -docs/releases/v3.0.0.md,v3.0.0:BUILD_GUIDE.md,absolute-blob,,yes -docs/releases/v3.0.0.md,v3.0.0:BUILD_GUIDE_v2.md,absolute-blob,,yes -docs/releases/v3.0.0.md,v3.0.0:CHANGELOG.md,absolute-blob,,yes -docs/releases/v3.0.0.md,v3.0.0:hardware/bom/bom_v3.0.csv,absolute-blob,,yes +docs/releases/v3.0.0-notes.md,/,site,,yes +docs/releases/v3.0.0-notes.md,BUILD_GUIDE.md,absolute-blob,2-power-input--use-the-screw-terminal,yes +docs/releases/v3.0.0-notes.md,v3.0.0:BUILD_GUIDE.md,absolute-blob,,yes +docs/releases/v3.0.0-notes.md,v3.0.0:BUILD_GUIDE_v2.md,absolute-blob,,yes +docs/releases/v3.0.0-notes.md,v3.0.0:CHANGELOG.md,absolute-blob,,yes +docs/releases/v3.0.0-notes.md,v3.0.0:hardware/bom/bom_v3.0.csv,absolute-blob,,yes +docs/releases/v3.1.0-notes.md,/roadmap,site,,yes +docs/releases/v3.1.0-notes.md,v3.1.0:BUILD_GUIDE.md,absolute-blob,,yes +docs/releases/v3.1.0-notes.md,v3.1.0:BUILD_GUIDE.md,absolute-blob,2-power-input--use-the-screw-terminal,yes +docs/releases/v3.1.0-notes.md,v3.1.0:CHANGELOG.md,absolute-blob,,yes docs/releases/v3.1.0.md,/roadmap,site,,yes -docs/releases/v3.1.0.md,v3.1.0:BUILD_GUIDE.md,absolute-blob,,yes -docs/releases/v3.1.0.md,v3.1.0:BUILD_GUIDE.md,absolute-blob,2-power-input--use-the-screw-terminal,yes -docs/releases/v3.1.0.md,v3.1.0:CHANGELOG.md,absolute-blob,,yes +docs/releases/v3.10.0.md,docs/investigations/2026-09-firmware-runtime.md,relative,,yes +docs/releases/v3.10.5.md,/guide,site,,yes +docs/releases/v3.10.5.md,/guide/build,site,,yes +docs/releases/v3.10.5.md,/guide/make,site,,yes +docs/releases/v3.10.5.md,/guide/play,site,,yes +docs/releases/v3.3.0.md,/panel-tuner.html,site,,yes +docs/releases/v3.3.0.md,docs/panel-compatibility.md,relative,,yes +docs/releases/v3.4.0.md,/update,site,,yes +docs/releases/v3.5.1.md,docs/investigations/2026-08-core2-heap-and-the-5s-stall.md,relative,,yes +docs/releases/v3.6.3.md,docs/investigations/2026-08-the-panel-clock-and-the-wifi-radio.md,relative,,yes +docs/releases/v3.6.3.md,docs/pfst-v2-spec.md,relative,,yes +docs/releases/v3.7.0.md,/variants,site,,yes +docs/releases/v3.8.0.md,/variants,site,,yes docs/rest-api.md,docs/EDITIONS.md,relative,,yes 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 @@ -416,6 +454,9 @@ docs/rest-api.md,docs/midi-spec.md,relative,,yes docs/rest-api.md,docs/mqtt-spec.md,relative,,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 +docs/rfc-cleanup-progress.md,docs/investigations/2026-10-cleanup-step3-plan.md,relative,,yes +docs/rfc-cleanup-progress.md,docs/investigations/2026-10-cleanup-step4-plan.md,relative,,yes docs/rfc-cleanup-progress.md,docs/investigations/2026-10-doc-map.csv,relative,,yes docs/rfc-cleanup-progress.md,docs/rfc-cleanup.md,relative,,yes docs/rfc-core-and-variants-progress.md,docs/EDITIONS.md,relative,,yes @@ -428,6 +469,12 @@ 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/voice.md,AGENTS.md,relative,,yes +docs/voice.md,BUILD_GUIDE.md,relative,,yes +docs/voice.md,README.md,relative,,yes +docs/voice.md,docs/EDITIONS.md,relative,the-three-words,yes +docs/voice.md,docs/rfc-cleanup.md,relative,210-writing-voice,yes +docs/voice.md,docs/voice-banned.txt,relative,,yes firmware/CUSTOM_PATTERNS.md,/,site,,yes firmware/CUSTOM_PATTERNS.md,/update,site,,yes firmware/CUSTOM_PATTERNS.md,firmware/README.md,relative,loadable-pattern-modules-pfm,yes @@ -435,9 +482,9 @@ firmware/CUSTOM_PATTERNS.md,firmware/README.md,relative,required-board-package,y firmware/README.md,/editions,site,,yes firmware/README.md,/guide/play,site,flash,yes firmware/README.md,/update,site,,yes -firmware/README.md,AUDIO_GUIDE.md,relative,,yes firmware/README.md,BUILD_GUIDE.md,relative,8-firmware,yes firmware/README.md,PATTERN_GUIDE.md,relative,,yes +firmware/README.md,docs/AUDIO_GUIDE.md,relative,,yes firmware/README.md,docs/EDITIONS.md,relative,,yes firmware/README.md,docs/README.md,relative,,yes firmware/README.md,docs/audio-ws-spec.md,relative,,yes @@ -686,7 +733,7 @@ tools/README.md,tools/rtpmidi-probe/README.md,relative,,yes tools/case-models/README.md,/build,site,,yes tools/patternflow-audio-android/README.md,/editions,site,,yes tools/patternflow-audio-extension/README.md,/editions,site,,yes -tools/patternflow-audio-extension/README.md,AUDIO_GUIDE.md,relative,,yes +tools/patternflow-audio-extension/README.md,docs/AUDIO_GUIDE.md,relative,,yes tools/patternflow-audio-extension/README.md,docs/audio-ws-spec.md,relative,,yes tools/patternflow-audio-extension/README.md,firmware/patternflow/console/README.md,relative,the-page-that-is-assembled-audio-in,yes tools/rtpmidi-probe/README.md,docs/midi-spec.md,relative,,yes @@ -845,8 +892,8 @@ web/src/app/editions/editions-data.ts,firmware/bundles/performance,absolute-blob web/src/app/editions/page.tsx,docs/EDITIONS.md,absolute-blob,,yes web/src/app/editions/page.tsx,docs/EDITIONS.md,absolute-blob,getting-an-edition-listed,yes web/src/app/features/TryInstall.tsx,/,site,,yes -web/src/app/features/features-data.ts,AUDIO_GUIDE.md,absolute-blob,,yes web/src/app/features/features-data.ts,PATTERN_GUIDE.md,absolute-blob,,yes +web/src/app/features/features-data.ts,docs/AUDIO_GUIDE.md,absolute-blob,,yes web/src/app/features/features-data.ts,docs/audio-ws-spec.md,absolute-blob,,yes web/src/app/features/features-data.ts,docs/director-midi.md,absolute-blob,,yes web/src/app/features/features-data.ts,docs/midi-spec.md,absolute-blob,,yes @@ -907,6 +954,7 @@ web/src/app/roadmap/roadmap-data.ts,CHANGELOG.md,absolute-blob,,yes web/src/app/roadmap/roadmap-data.ts,docs/EDITIONS.md,absolute-blob,,yes web/src/app/roadmap/roadmap-data.ts,docs/osc-spec.md,absolute-blob,,yes web/src/app/roadmap/roadmap-data.ts,docs/panel-compatibility.md,absolute-blob,,yes +web/src/app/roadmap/roadmap-data.ts,docs/releases/v2.0.0.md,absolute-blob,,yes web/src/app/roadmap/roadmap-data.ts,firmware/CUSTOM_PATTERNS.md,absolute-blob,,yes web/src/app/roadmap/roadmap-data.ts,integrations/ableton,absolute-blob,,yes web/src/app/roadmap/roadmap-data.ts,v1.0.0:docs/BUILD.md,absolute-blob,,yes @@ -950,7 +998,7 @@ web/src/app/terms/page.tsx,docs/LICENSE-SUMMARY.md,absolute-blob,,yes web/src/components/guide/build/build.test.ts,BUILD_GUIDE.md,absolute-blob,1-bill-of-materials-bom,yes web/src/components/guide/build/build.test.ts,BUILD_GUIDE.md,absolute-blob,10-known-issues--design-notes,yes web/src/components/guide/build/build.test.ts,docs/panel-compatibility.md,absolute-blob,,yes -web/src/components/guide/copy/audio.ts,AUDIO_GUIDE.md,absolute-blob,,yes +web/src/components/guide/copy/audio.ts,docs/AUDIO_GUIDE.md,absolute-blob,,yes web/src/components/guide/copy/audio.ts,docs/director-midi.md,absolute-blob,,yes web/src/components/guide/copy/audio.ts,docs/midi-spec.md,absolute-blob,,yes web/src/components/guide/copy/audio.ts,docs/osc-spec.md,absolute-blob,,yes From 84a3a3fbd6a8f61b1b2d140ef39a5de5cc24018f Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 15 Oct 2026 00:10:15 +0000 Subject: [PATCH 3/3] =?UTF-8?q?docs:=20close=20step=201=20in=20the=20docs?= =?UTF-8?q?=20map=20=E2=80=94=20root=20rule,=20releases/,=20voice,=20the?= =?UTF-8?q?=20two=20lists?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The root keeps three guides now that the audio guide is in docs/, the changelog lives in docs/releases/, and voice.md and the parity CSV had no entry in docs/README.md. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01S5utCYhZ1dCRVsV4UgD716 --- docs/README.md | 7 ++++--- docs/REPOSITORY.md | 4 ++-- docs/investigations/2026-10-doc-map.csv | 2 ++ 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2e19b448..2858bb91 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # docs/ -What is here, and what is not. The rule for the split: **a guide somebody follows start to finish lives at the repository root** (`BUILD_GUIDE.md`, `PATTERN_GUIDE.md`, `FEATURE_GUIDE.md`); **a contract, a reference, a walk-through for one task, or a record lives here**; and a folder explains itself in its own README. The folder-by-folder map of the whole repository is [`REPOSITORY.md`](REPOSITORY.md). +What is here, and what is not. The rule for the split: **the repository root keeps three guides and no others** (`BUILD_GUIDE.md`, `PATTERN_GUIDE.md`, `FEATURE_GUIDE.md`), so a first-time visitor reads it at a glance; **a contract, a reference, a walk-through for one task (the audio guide is one), or a record lives here**; and a folder explains itself in its own README. The folder-by-folder map of the whole repository is [`REPOSITORY.md`](REPOSITORY.md). ## Contracts — other software is built against these, not against the firmware source @@ -42,6 +42,7 @@ The interactive guide at [patternflow.work/guide](https://patternflow.work/guide - [`../CONTRIBUTING.md`](../CONTRIBUTING.md) — one table: what you have → where it goes → what CI runs on it - [`../.github/SUPPORT.md`](../.github/SUPPORT.md) — where to ask what - [`REPOSITORY.md`](REPOSITORY.md) — the folder-by-folder map, and the list of files that outside things link to +- [`voice.md`](voice.md) — how the docs sound in English and in Korean, with the words that stay out in [`voice-banned.txt`](voice-banned.txt) ## Running the project @@ -50,7 +51,7 @@ The interactive guide at [patternflow.work/guide](https://patternflow.work/guide ## Records -- [`investigations/`](investigations/) — dated post-mortems -- [`releases/`](releases/) — long-form notes for three July 2026 releases, kept as written; notes since 3.2 are on [GitHub Releases](https://github.com/engmung/Patternflow/releases), and `CHANGELOG.md` at the root is the complete record +- [`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 +- [`releases/`](releases/) — every release's changelog section as written, one file each (`vX.Y.Z.md`), back to v1.0.0; `CHANGELOG.md` at the root keeps the three newest in full and links the rest. `v3.0.0-notes.md` and `v3.1.0-notes.md` are long-form notes for two July 2026 releases, beside the v3.0.0 launch checklist; notes since 3.2 are on [GitHub Releases](https://github.com/engmung/Patternflow/releases) - [`manifesto.md`](manifesto.md) — why Patternflow exists, and (section 6) how we treat each other - [`images/`](images/), [`media/`](media/) — assets the guides and the site reference diff --git a/docs/REPOSITORY.md b/docs/REPOSITORY.md index 6071a2b1..ea4963b7 100644 --- a/docs/REPOSITORY.md +++ b/docs/REPOSITORY.md @@ -9,13 +9,13 @@ A map for people. (AI coding agents get the same map with more rules in [`../AGE | `firmware/` | The ESP32-S3 firmware. `patternflow/` is the sketch: `patternflow.ino`, `config.h` (pins, brightness, limits, calibration), `net_config.h` (Wi-Fi, OTA, update defaults), `src/` (the engine: HUB75 driver, encoders, canvas, colour, noise, Wi-Fi, web console — the **core**, compiled unchanged into every published firmware), `features/` (everything optional: OSC, audio, the microphone, MQTT, MIDI, shows, weather, clock, BLE — attached through hooks the core exposes), `presets/` (the curated patterns), `abi/` (the frozen contract a `.pfm` module is compiled against), `console/` (the device's web pages as plain HTML). `bundles/` names the compositions — the shelf editions `audio` and `performance`, plus `clock` and `midi`, which CI keeps compiling but the shelf does not carry — and holds `build.sh` and `shelf.sh`. `toolchain/` is the repo-level scripts: build a module, make the Basics pack, and the `check_*.py` that CI runs. `modules/` is the module toolchain's working folder, not a place patterns are contributed to. `encoder_test/` is a standalone sketch for checking the four encoders, and `CUSTOM_PATTERNS.md` the hands-on pattern route | [`firmware/README.md`](../firmware/README.md) for building; [`EDITIONS.md`](EDITIONS.md) before touching anything | | `hardware/` | `pcb/` (KiCad source, Gerbers per revision, schematic PDF), `case/` (STLs by printer bed size, knob plates, the Blender source, legacy v2 cases, the old v1/v2 laser-cut drawings in `legacy_lasercut/`, and `remixes/` — enclosures other people designed and built, one folder each), `bom/` (the CSV that is the BOM source of truth) | [`hardware/README.md`](../hardware/README.md) | | `web/` | The Next.js site at patternflow.work: landing page, the interactive guide (`/guide`, with `/guide/build`, `/guide/play`, `/guide/make` and `/guide/audio`), Live Editor, Pattern Lab, the community (only on the community host), the browser flasher (the **Flash Patternflow** button on the Pattern tab and in the Play guide; the images it installs are `public/flash/`), edition shelf, feature catalogue, device update handoff, journal, roadmap. The JS presets in `src/lib/presets/` are the source of truth for the firmware's preset headers. The breadboard build guide is a React page here, `src/app/build/breadboard/` | [`web/README.md`](../web/README.md), then [`web/ARCHITECTURE.md`](../web/ARCHITECTURE.md) | -| `docs/` | Contracts other software is built against, how the firmware is put together, walk-throughs, the audio guide (`AUDIO_GUIDE.md`), the assembly map, the legacy v2.x build guide (`legacy/`), project records and media | [`README.md`](README.md) | +| `docs/` | Contracts other software is built against, how the firmware is put together, walk-throughs, the audio guide (`AUDIO_GUIDE.md`), the assembly map, the legacy v2.x build guide (`legacy/`), the writing voice (`voice.md` and `voice-banned.txt`), project records (`releases/`, one file per release) and media | [`README.md`](README.md) | | `tools/` | Clients Patternflow ships that run on their own: the audio-react browser extension (also the authoring source of the device's `/audio-in` page), the Android capture app, an RTP-MIDI probe. Also `case-models/`, the scripts that make the /build page's 3D model of each case, the official one and every remix on its case switch | [`tools/README.md`](../tools/README.md) | | `integrations/` | Bridges that run inside or beside someone else's software (Ableton / Max for Live today) and talk to the panel only through the contracts in `docs/` | [`integrations/README.md`](../integrations/README.md) | | `.github/` | Issue and pull-request templates (including the guide's **Stuck here?** form and **Share your build**), `SUPPORT.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, the CI workflows (web, every firmware composition, the core-names-no-feature checks, doc links, community folders carrying their README, console-page sync, firmware release assets, Discord dev-log) and their helper scripts | the header comment of each workflow | | root | `README.md`, the three guides (`BUILD_GUIDE.md`, `PATTERN_GUIDE.md`, `FEATURE_GUIDE.md`), `CHANGELOG.md`, `CONTRIBUTING.md`, `CITATION.cff`, the two license texts and the `LICENSE` pointer, `AGENTS.md` (+ `CLAUDE.md`, a one-line shim) | | -The rule for where a document lives: **a guide somebody follows start to finish is at the root; a contract, a reference or a record is in `docs/`; a folder explains itself in its own README.** +The rule for where a document lives: **the root keeps three guides and no others, so a first-time visitor reads it at a glance; a contract, a reference, a walk-through for one task or a record is in `docs/`; a folder explains itself in its own README.** ## What you want to do → where to start diff --git a/docs/investigations/2026-10-doc-map.csv b/docs/investigations/2026-10-doc-map.csv index 11902b10..9fe37878 100644 --- a/docs/investigations/2026-10-doc-map.csv +++ b/docs/investigations/2026-10-doc-map.csv @@ -293,6 +293,8 @@ docs/README.md,docs/releases,relative,,yes docs/README.md,docs/rest-api.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/voice-banned.txt,relative,,yes +docs/README.md,docs/voice.md,relative,,yes docs/README.md,firmware/CUSTOM_PATTERNS.md,relative,,yes docs/README.md,firmware/patternflow/console/README.md,relative,,yes docs/README.md,hardware/README.md,relative,,yes