Skip to content

docs(framework): streamline README, add recipes, extract marketplace doc#280

Merged
blafourcade merged 16 commits into
mainfrom
docs/readme-refacto
Jun 16, 2026
Merged

docs(framework): streamline README, add recipes, extract marketplace doc#280
blafourcade merged 16 commits into
mainfrom
docs/readme-refacto

Conversation

@alexsoyes

@alexsoyes alexsoyes commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

What

Rework the README into a lean landing page and introduce a recipes/ cookbook.

README

  • New tagline + marketplace-focused intro with an SDLC-orchestration line
  • The AI-Driven Dev section — who we are (3y R&D, 500+ devs trained EN/FR, 100% AI-generated code) + Discord / training / ecosystem CTAs, roadmap decisions every Thursday
  • Compatibility matrix — Claude Code native/recommended; Copilot, Codex, Cursor, OpenCode supported; Gemini & Mistral in progress
  • Installation — Claude Code shown in full; Copilot/Codex (marketplace) and Cursor/OpenCode (flat) in collapsible blocks, each linking the release asset
  • Quick start/aidd-context:00-onboard + a top-down flow diagram (idea → tested, shipped PR)
  • Plugins table, Recipes table, slim Contributing (issues/discussions + Discord) with a prominent roadmap CTA and the Core Team note, Trust & safety, and a docs/-only documentation table

Moved out (no duplication)

  • docs/MARKETPLACE.md — marketplaces, install scopes, versioning, LLM tier reference (was inline in the README)

Recipes (new)

  • recipes/README.md — index
  • recipes/mcp-installation.md — "MCP installations" (migrated from the README MCP section); its shape doubles as the de-facto recipe template

Companion PR

🤖 Generated with Claude Code

Rework the README to a lean landing page: who we are + contact, a
supported-tools table (Claude Code recommended), a quick start centered
on /aidd-context:00-onboard and the dev flow, plugins, recipes, and a
trimmed docs index. 343 -> 193 lines.

Move marketplaces / scopes / versioning / LLM-tier reference out of the
README into docs/MARKETPLACE.md (linked, no duplication).

Add recipes/ as task-oriented how-to sheets: an index plus
recipes/mcp_installation.md (migrated from the README MCP section),
whose shape doubles as the de-facto recipe template.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
alexsoyes and others added 3 commits June 16, 2026 14:20
…TA, less emoji

Drop the Claude-Code-only framing and the top nav links. Trim section
emoji. Make the community section a Discord/training CTA (remove personal
links). Add a real Installation section explaining marketplace
(recommended) vs flat archives per tool. Redraw the flow as a top-down
diagram with a concrete example. Reduce the Documentation table to the
docs/ folder only (GitHub surfaces root community files natively).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
A stray copy of the cook skill (which belongs to PR #281) had leaked into
plugins/ and the count hook picked it up, inflating the README to 38/13.
This PR adds no skill — restore 37 skills / aidd-context 12.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…pe table, mermaid styling

Add emojis to section titles, link the GitHub releases page, turn the
install/quick-start explanations into short numbered lists, give Recipes
a two-column table, and bold the skill commands in the flow diagram with
a green "tested · shipped" end node.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@alexsoyes alexsoyes marked this pull request as ready for review June 16, 2026 12:32
alexsoyes and others added 3 commits June 16, 2026 14:40
…per community & contributing

Add a compatibility matrix up top (Gemini/Mistral marked in progress).
Expand non-Claude install into detailed per-tool steps (Copilot, Codex,
Cursor, OpenCode) and drop the unneeded flat/tier note. Recommend
installing all plugins. Mention /cook in Recipes. Make the community
section a who-we-are pitch with a training CTA (drop the socials line),
and the contributing section more inviting with a Core Team note.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…th release links

Adopt the "Vibe Coding for professional developers" tagline and a
marketplace-focused intro with an SDLC-orchestration tffline. Add a
compatibility note (Claude Code first, others ensured). Collapse the
non-Claude installs into <details> (Claude Code stays fully visible),
each with a link to the release asset. Fix the programme/ecosystem links.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rename recipes/mcp_installation.md -> recipes/mcp-installation.md (kebab,
consistent with repo conventions and the /cook upsert slug), fix links,
and add emoji + numbered steps to match the recipe template. Also ignore
.claude/worktrees/ so agent worktrees never get committed again.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@alexsoyes alexsoyes force-pushed the docs/readme-refacto branch from d7adb58 to 69f968f Compare June 16, 2026 12:54
alexsoyes and others added 9 commits June 16, 2026 14:54
…ity table

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…en recipe, link roadmap

Move a one-line "who we are" into the intro block (3y R&D, 500+ devs,
100% AI code) and keep Community to the CTAs only. Remove the "Built for
Claude Code" badge (mixed signal vs multi-tool). Drop the not-yet-written
token recipe row. Link the roadmap from the contributing note.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ing, drop /cook note

Move the Discord/training/ecosystem CTAs into three bullets right under
who-we-are and remove the now-duplicate Community section. Trim
Contributing to issues/discussions + Discord (keeping the roadmap CTA and
the Core Team note). Drop the /cook line from Recipes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… | Level)

Make recipes/README.md use the same Goal column /cook's list emits and
upsert maintains, sourced from the recipe's `> **Goal:**` line, so the
index, the list output, and the recipe never drift. Capitalize the Goal.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… "in France"

Align the recipe title and index with the README table (plural), and
remove the "(in France)" aside from who-we-are (the badge and footer
already say it).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@blafourcade blafourcade merged commit a139b52 into main Jun 16, 2026
9 checks passed
@blafourcade blafourcade deleted the docs/readme-refacto branch June 16, 2026 19:28
@aidd-bot aidd-bot Bot mentioned this pull request Jun 16, 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