Skip to content

docs: rewrite the README narrative with real examples and a hero demo - #21

Merged
oveddan merged 1 commit into
mainfrom
claude/docs-polish-images
Sep 22, 2026
Merged

oveddan merged 1 commit into
mainfrom
claude/docs-polish-images

Conversation

@oveddan

@oveddan oveddan commented Sep 22, 2026

Copy link
Copy Markdown
Owner

A chat asks for new knob colors; the MIDI Fighter Twister's knobs change to match

What changed

Narrative. "The problem" and "What this changes" are now my own dictation, lightly edited for grammar and verbal tics, and written without first person. They cover the four banks, on/off colors, toggle or tap, the open-source firmware, and why programming the Twister and its mappings by hand is slow. The DJ TechTools product page and the firmware repo are linked.

Examples. Five exchanges adapted from my Chromatik sessions, each showing the prompt and the agent's reply, trimmed. The prompts come from the session archive, rephrased as questions without first person. The first is my own MPD218 mapping from RobotHeart moved onto the Twister. The last three are collapsed so the install section stays close. The section says the Chromatik side goes through Chromatik's MCP server and the Twister side through this CLI. The examples are Chromatik-specific for now; generalizing them is a later pass.

Images. Main referenced four images that don't exist, so GitHub showed four broken-image icons.

  • The hero is a real 21-second demo: a chat on the left asks for new colors, and the knobs change on the right. It's the same exchange as the "New colors" example.
  • Bank 1 of the Twister map the agent keeps for my show sits at the end of "What this changes".
  • Both are hosted on R2, not committed. The video source is 107 MB, over GitHub's 100 MB limit, and GitHub won't play external video in a README, so it shows a 4.7 MB GIF that links to a 3 MB MP4.
  • The other three image references are gone. The one image still wanted (a stock-editor before/after) is a TODO in docs/images/README.md.

"What this is not" is cut. The firmware attribution moved into Protocol coverage. The reference manual below is otherwise unchanged, and the README stays one file.

Still to come in this PR

  • Before/after screenshot of the stock editor

Out of scope

🤖 Generated with Claude Code

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 22, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-22T23:24:30.365136Z 30dded9 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@oveddan
oveddan force-pushed the claude/docs-polish-images branch 2 times, most recently from 029de8b to d8222e7 Compare September 22, 2026 16:23
Comment thread README.md Outdated
@oveddan
oveddan force-pushed the claude/docs-polish-images branch 2 times, most recently from dc75651 to e346bbd Compare September 22, 2026 17:40
Comment thread README.md Outdated
@oveddan
oveddan force-pushed the claude/docs-polish-images branch from e346bbd to 04d286f Compare September 22, 2026 18:06

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 04d286f678

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment thread README.md Outdated
@oveddan
oveddan force-pushed the claude/docs-polish-images branch from 04d286f to 2d1eada Compare September 22, 2026 18:09

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2d1eada57a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
@oveddan
oveddan force-pushed the claude/docs-polish-images branch 2 times, most recently from aa40d70 to fe146bf Compare September 22, 2026 18:19
@oveddan oveddan changed the title docs: tighten the README narrative and add the hero demo docs: rewrite the README narrative with real examples and a hero demo Sep 22, 2026
@oveddan
oveddan force-pushed the claude/docs-polish-images branch 4 times, most recently from db25d0a to bede6cb Compare September 22, 2026 22:57

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bede6cb1f8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
@oveddan
oveddan force-pushed the claude/docs-polish-images branch 5 times, most recently from 66bb8f6 to dce5652 Compare September 22, 2026 23:20
"The problem" and "What this changes" are now Dan's own dictation, lightly
edited and written without first person: four banks, on/off colors, toggle or tap, the open-source
firmware, and why programming the Twister and its mappings by hand is
slow. The DJ TechTools product page and firmware repo are linked.

A new Examples section shows five exchanges adapted from real Chromatik
sessions, each with the prompt and the agent's reply, trimmed. The first
is an MPD218 mapping from RobotHeart moved onto the Twister. The last three are collapsed. The
section says the Chromatik side goes through Chromatik's MCP server.

The hero is a real demo, a split screen of a chat changing the knob
colors, hosted on R2 because the source is over GitHub's 100 MB limit.
The README shows a 4.7 MB GIF linking to a 3 MB MP4. Below "What this
changes" is bank 1 of the Twister map artifact the agent keeps for the
show, also on R2. The three missing image references are gone, and
docs/images/README.md tracks the one image still wanted.

"What this is not" is cut. The firmware attribution moved into Protocol
coverage.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@oveddan
oveddan force-pushed the claude/docs-polish-images branch from dce5652 to 30dded9 Compare September 22, 2026 23:21
@oveddan
oveddan merged commit 653d74d into main Sep 22, 2026
5 checks passed
@oveddan
oveddan deleted the claude/docs-polish-images branch September 22, 2026 23:27
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