Skip to content

docs: README overhaul (brand header, dash-free, accuracy fix) - #25

Merged
EthanY33 merged 1 commit into
mainfrom
chore/readme-overhaul
Jun 27, 2026
Merged

docs: README overhaul (brand header, dash-free, accuracy fix)#25
EthanY33 merged 1 commit into
mainfrom
chore/readme-overhaul

Conversation

@EthanY33

Copy link
Copy Markdown
Owner

Part of the GitHub profile overhaul. Surgical README upgrade, no code changes.

What changed

  • Adds a 1280x640 brand card header (docs/social.png, abstract cyan-on-black, matches goneidle.com palette).
  • Converts every em dash to plain punctuation (personal voice rule).
  • Accuracy fix: the README claimed per-channel FIFO ordering enforced by a per-channel broadcast mutex. That mutex was removed in 22fd26d to avoid head-of-line blocking. Corrected to per-subscriber FIFO with concurrent Broadcast, matching internal/hub/channel.go.
  • Control-plane routes, leak/shutdown tests, and all relative links verified against source.

Safe to merge or close.

- Add 1280x640 brand card header (docs/social.png)
- Convert em dashes to plain punctuation (voice rule)
- Fix stale claim: README described per-channel FIFO via a broadcast mutex,
  but that mutex was removed (22fd26d). Corrected to per-subscriber FIFO with
  concurrent Broadcast, matching internal/hub/channel.go
- Docs list and headings use colons instead of dashes
@EthanY33
EthanY33 merged commit d253635 into main Jun 27, 2026
2 checks passed
@EthanY33
EthanY33 deleted the chore/readme-overhaul branch June 27, 2026 16:55
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