Skip to content

docs(framework): clarify README pitch, terms, and install list#410

Merged
blafourcade merged 2 commits into
nextfrom
docs/readme-clarity-pass
Jul 9, 2026
Merged

docs(framework): clarify README pitch, terms, and install list#410
blafourcade merged 2 commits into
nextfrom
docs/readme-clarity-pass

Conversation

@TheShinriel

Copy link
Copy Markdown
Contributor

🎯 What & why

The install-first rework still left a first-time reader with an abstract pitch, undefined Marketplace/Flat terms, a 7-vs-6 plugin count mismatch, and an asymmetric table row small frictions that add up when scanning the README end to end.

🛠️ How it works

  • Ground the pitch in one runnable example instead of a list of nouns: README.md:33 now shows /aidd-dev:00-sdlc "..." chained through its real actions (spec → plan → implement → review → ship), matched against plugins/aidd-dev/skills/00-sdlc/SKILL.md so the example doesn't drift from the skill.
  • Define Marketplace vs Flat where the compatibility table first uses them: README.md:58, instead of only inside the Cursor <details> block further down.
  • Note the Claude Code install list covers the 6 stable plugins (aidd-ui is alpha) so the count matches the header badge: README.md:64.
  • Pad the aidd-ui row to three cells like every other row in the plugins table: README.md:276.
  • Add a FAQ entry for "why not just write my own skills?" docs/FAQ.md:5 linked from the new pitch instead of expanded inline, to keep the README skimmable.

🧪 How to verify

  • Render README.md and docs/FAQ.md: the pitch example, the Marketplace/Flat note, and the plugins table should read correctly with no dangling anchors.
  • Click the FAQ link from the pitch (README.md:40) and confirm it lands on the new entry.

⚠️ Heads-up

Doc-only change, scoped to the points listed above. Other feedback raised during review (star-CTA placement, next-branch stability messaging) was left untouched those are maintainer/branding calls, not folded into this PR.

✅ I certify

  • I DO CERTIFY I READ EACH LINE OF THE PULL REQUEST BECAUSE I AM A SOFTWARE ENGINEER, NOT A AI PUPPY.

The install-first rework still left a first-time reader with an
abstract pitch, undefined Marketplace/Flat terms, a 7-vs-6 plugin
count mismatch in the install block, and an asymmetric row in the
plugins table.

- Ground the pitch in one runnable /aidd-dev:00-sdlc example instead
  of a list of nouns.
- Define Marketplace vs Flat where the compatibility table first uses
  them, not only inside the Cursor details block.
- Note that the Claude Code install list covers the 6 stable plugins
  (aidd-ui is alpha) so the count matches the header badge.
- Pad the aidd-ui table row to three cells like every other row.
- Add a FAQ entry answering "why not just write my own skills?",
  linked from the new pitch.
@blafourcade blafourcade merged commit 984fab8 into next Jul 9, 2026
7 checks passed
blafourcade pushed a commit that referenced this pull request Jul 10, 2026
* docs(framework): clarify README pitch, terms, and install list

The install-first rework still left a first-time reader with an
abstract pitch, undefined Marketplace/Flat terms, a 7-vs-6 plugin
count mismatch in the install block, and an asymmetric row in the
plugins table.

- Ground the pitch in one runnable /aidd-dev:00-sdlc example instead
  of a list of nouns.
- Define Marketplace vs Flat where the compatibility table first uses
  them, not only inside the Cursor details block.
- Note that the Claude Code install list covers the 6 stable plugins
  (aidd-ui is alpha) so the count matches the header badge.
- Pad the aidd-ui table row to three cells like every other row.
- Add a FAQ entry answering "why not just write my own skills?",
  linked from the new pitch.

* Missing part with aidd-ui, details for claude's commande lineand remove td at the end
@aidd-bot aidd-bot Bot mentioned this pull request Jul 10, 2026
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.

2 participants