Skip to content

docs: README reads for people, grouped by what you give and get - #24

Merged
baransu merged 2 commits into
masterfrom
tomasz/readme-docs-principles
Oct 26, 2026
Merged

baransu merged 2 commits into
masterfrom
tomasz/readme-docs-principles

Conversation

@baransu

@baransu baransu commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

👋 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

  • Skills are grouped into Give your agent a Jam and Get a Jam back. Each skill gets one plain line: what you say, then what you get.
  • One line above the groups says you don't need to remember the names: paste a Jam link, say what you want, and your agent picks the skill.
  • Requirements are a list, one per line: account, CLI (or Jam MCP for the reading skills), video-to-jam's tools, the CI token, and jam-proof's platforms.
  • "A Jam is a screen recording or screenshot…", matching the brand. "You'd record one for a bug report, a feedback walkthrough or a demo" replaces "…already live there".
  • Jam's docs rules: no semicolons in prose. Bold only for UI labels. "Jam MCP" is the name, and "Model Context Protocol (MCP)" appears on its first mention.

Review guide

  1. MECHANICAL README.md: Skills and Requirements
  2. MECHANICAL CHANGELOG.md

Verification

  • node scripts/check.mjs passes. It still finds every skill's list entry under the new group headings.
  • npm test passes 34/34.

Not verified: the rendered page on GitHub.

Rollback

Revert this PR.

@baransu
baransu force-pushed the tomasz/readme-docs-principles branch from 2320362 to f8438df Compare October 26, 2026 12:38
@baransu baransu changed the title docs: README follows Jam's docs writing rules docs: README reads for people, grouped by what you give and get Oct 26, 2026

@devin-ai-integration devin-ai-integration 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.

Devin Review found 1 potential issue.

Devin Review

Comment thread README.md

### 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 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.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

@baransu
baransu merged commit 1b7ef5d into master Oct 26, 2026
2 checks passed
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