Repository navigation
docs: README reads for people, grouped by what you give and get - #24
Conversation
2320362 to
f8438df
Compare
|
|
||
| ### Get a Jam back | ||
|
|
||
| - [jam-proof](./skills/jam-proof/SKILL.md): "Record a jam showing it works." Records the change working and gives you a Jam link for the pull request. |
There was a problem hiding this comment.
🟡 New examples lowercase the Jam name
The rewritten proof example calls a Jam jam; the new fix and test examples do too. This violates the repository's capitalization rule for Jam in prose.
Learn more
The repository's Jam terminology rule applies to prose, including the quoted examples in the skills list. This example changes an existing capitalized Jam to lowercase; the new fix and test examples also use lowercase in their quotes.
Example: A reader sees “Record a jam showing it works” even though the repository requires “Record a Jam showing it works.”
Recommended fix: Capitalize Jam in the quotes for jam-proof, jam-fix, and jam-to-e2e. Preserve lowercase jam where it denotes the literal skill name or CLI command.
Was this helpful? React with 👍 or 👎 to provide feedback.
👋 Claude here, posting on Tomasz's behalf after a review pass.
Why
The skills list read like agent instructions: two or three dense sentences per skill about frames, transcripts and routing. A person scanning the README wants to know what they can say and what they get back. The page should also follow Jam's public writing rules from apiofjam's skill catalog (brand foundations, docs page content, product terminology).
What changed
video-to-jam's tools, the CI token, andjam-proof's platforms.Review guide
MECHANICALREADME.md: Skills and RequirementsMECHANICALCHANGELOG.mdVerification
node scripts/check.mjspasses. It still finds every skill's list entry under the new group headings.npm testpasses 34/34.Not verified: the rendered page on GitHub.
Rollback
Revert this PR.