README: the Slack module joins the list of included modules #5

Merged
michael merged 1 commits from claude/readme-slack-module into main 2026-09-17 12:43:34 -04:00
Owner

grep -i slack README.md returned nothing. Every other shipped module had an
entry under Included modules — ProdCom, ProPresenter, Timers, PCO Plan,
Clock — but the module that posts to Slack as the campus was missing from the
README entirely.

The entry, written in the neighbours' shape and voice and taken from
modules/slack/module.json and modules/slack/client.js rather than from
memory:

  • what it does — live transcripts of the location's channels plus
    PIN-protected sending as the location;
  • the + picker tiles — one transcript per configured channel (titled
    #channel), plus Send message and Quick replies, which are
    single: true, so one of each per dashboard, both posting to whichever
    transcript was clicked last;
  • the four admin groups — Slack account (token, Send as), Channels,
    Transcript (refresh interval, messages kept, thread replies) and
    Sending (the sendEnabled toggle in the group's title row, PIN,
    auto-lock minutes, quick replies, quick emojis);
  • the tile settings — avatars, timestamps, names, channel notices.

Note the group count: the issue named three groups, but configSchema also
puts pollSeconds, historyCount and includeReplies under a Transcript
group. A group renders as its own admin subsection whether or not
configGroups dresses it up, so the README says four.

The mocks paragraph listed ProdCom, ProPresenter and PCO but not Slack,
though CLAUDE.md has documented it all along. It now ends with
node tools/slack-mock.js 24716 and the SLACK_API_BASE=http://127.0.0.1:24716/api
line it needs to be of any use.

Documentation only — no code, no module or shell version bump.

🤖 Generated with Claude Code

`grep -i slack README.md` returned nothing. Every other shipped module had an entry under **Included modules** — ProdCom, ProPresenter, Timers, PCO Plan, Clock — but the module that posts to Slack as the campus was missing from the README entirely. **The entry**, written in the neighbours' shape and voice and taken from `modules/slack/module.json` and `modules/slack/client.js` rather than from memory: - what it does — live transcripts of the location's channels plus PIN-protected sending as the location; - the + picker tiles — one transcript per configured channel (titled `#channel`), plus **Send message** and **Quick replies**, which are `single: true`, so one of each per dashboard, both posting to whichever transcript was clicked last; - the four admin groups — **Slack account** (token, Send as), **Channels**, **Transcript** (refresh interval, messages kept, thread replies) and **Sending** (the `sendEnabled` toggle in the group's title row, PIN, auto-lock minutes, quick replies, quick emojis); - the tile settings — avatars, timestamps, names, channel notices. Note the group count: the issue named three groups, but `configSchema` also puts `pollSeconds`, `historyCount` and `includeReplies` under a **Transcript** group. A `group` renders as its own admin subsection whether or not `configGroups` dresses it up, so the README says four. **The mocks paragraph** listed ProdCom, ProPresenter and PCO but not Slack, though `CLAUDE.md` has documented it all along. It now ends with `node tools/slack-mock.js 24716` and the `SLACK_API_BASE=http://127.0.0.1:24716/api` line it needs to be of any use. Documentation only — no code, no module or shell version bump. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
michael added 1 commit 2026-09-17 09:10:52 -04:00
Every shipped module had an entry under "Included modules" except Slack,
which wasn't mentioned anywhere in the README — so the one module that can
send as the campus was also the one nobody could read about.

Its entry now sits with the others, in their shape: what it does, the tiles
it offers in the + picker (one transcript per configured channel plus the
two single send surfaces), its four admin groups and its tile settings —
all taken from modules/slack/module.json and client.js.

The testing paragraph listed the ProdCom, ProPresenter and PCO mocks but
not the Slack one, though CLAUDE.md has documented it all along; it is now
there with the SLACK_API_BASE line it needs.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
michael merged commit f5eb611872 into main 2026-09-17 12:43:34 -04:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: michael/ProdDash#5