Skip to content

Show pros and cons in a list instead of inline #497

Description

@williamthorsen

Problem

The recommendation-gradient format presents pros and cons inline, separated by ;. When options carry multiple items or longer text, the inline format is hard to parse — option boundaries blur and individual pros/cons run together.

Context

The format is defined in packages/agents/content/skills/_data/recommendation-gradient.md and modeled in two other places:

  • packages/agents/content/skills/_data/design-priorities.md — convenience-led / correctness-led ranking examples
  • packages/agents/content/skills/design-and-plan/SKILL.md — inline reminder bullet (line 71)

Design decisions:

  • Always put each pro/con on its own line, even when an option has only a single item. One rule, predictable output, no per-case judgement.
  • Indent each item line by 3 spaces, aligning with the option title's first character after 1. .
  • Keep / . No Unicode pair offers reliable color in Markdown/terminal rendering, and emoji alternatives (/, 🟢/🔴) carry semantic mismatches or collide with existing markers (the 🟢 recommended next-steps convention).
  • Keep punctuation: ; between items, . on the last.

Solution

Update the canonical "Format" section and both example blocks in recommendation-gradient.md to require one pro/con per line with a 3-space indent. Reformat the two ranking examples in design-priorities.md to match. In design-and-plan/SKILL.md, remove the inline example from the recommendation-gradient bullet — the canonical spec is already linked, so duplicating the format invites drift.

The new shape:

1. ■■■ Option title:
   ➕ first pro;
   ➕ second pro;
   ➖ con.

Acceptance criteria

  • The "Format" section in recommendation-gradient.md requires one item per line with 3-space indent, applied even to single-item options.
  • Both example blocks in recommendation-gradient.md reflect the new format.
  • Both ranking examples in design-priorities.md reflect the new format.
  • The recommendation-gradient bullet in design-and-plan/SKILL.md no longer contains an inline format example; it refers to the canonical spec only.

Metadata

Metadata

Labels

featureAdded or improved external functionalityscope:agents

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions