Skip to content

docs(readme): restructure installation into per-harness Quickstart blocks#4

Merged
kherembourg merged 1 commit into
mainfrom
docs/readme-quickstart-harnesses
May 19, 2026
Merged

docs(readme): restructure installation into per-harness Quickstart blocks#4
kherembourg merged 1 commit into
mainfrom
docs/readme-quickstart-harnesses

Conversation

@kherembourg
Copy link
Copy Markdown
Contributor

Objectif

Restructurer la section installation du README.md sur le modèle obra/superpowers — un bloc copy-paste-able par harness, dans cet ordre exact :

  1. Claude Code
  2. Codex CLI
  3. Codex App
  4. Cursor
  5. Gemini CLI (via gemini-extension.json ajouté en PR feat(manifests): add root AGENTS.md, GEMINI.md, and gemini-extension.json #3)
  6. OpenCode (sera complété par la PR OpenCode dédiée)
  7. GitHub Copilot CLI
  8. Mistral vibe
  9. Windsurf
  10. JetBrains AI / VS Code + Continue (en fold)

Changements

  • Nouvelle section ## Quickstart placée juste après le pitch, avec un bloc shell/JSON copy-paste-able par harness — pas de prose superflue.
  • Section ## Installation (legacy / all-in-one) remplace l'ancienne Quick Install (Options 1/2/3) et garde install.sh documenté pour les usages de bootstrap multi-tools.
  • Section Project Structure mise à jour pour mentionner AGENTS.md, GEMINI.md, gemini-extension.json (ajoutés en PR feat(manifests): add root AGENTS.md, GEMINI.md, and gemini-extension.json #3) et .opencode/INSTALL.md (à venir).
  • Sections préservées telles quelles : What It Does, Usage Examples, Supported Platforms, Requirements, Contributing, Updating for New SDK Versions, Security, Changelog, License, Resources.
  • Le bloc Discoverability (agentskill.sh) est retiré au profit de la futur PR roadmap des marketplaces.

Dépendance

Cette PR dépend de #3 (feat/root-manifests) pour que les blocs Gemini CLI (gemini extensions install ...) et Codex CLI (cp configs/codex/AGENTS.md AGENTS.md → bientôt remplaçable par "rien à faire, le fichier est déjà à la racine") aient du sens. À merger après #3.

Acceptance criteria

  • Section Quickstart en haut, juste après le pitch.
  • Section Installation (legacy) remplace l'ancienne Quick Install.
  • Tous les blocs sont copy-paste-able (commandes shell ou snippet JSON).
  • CHANGELOG.md mis à jour : ### ChangedRestructured README installation section into per-harness Quickstart blocks.

Generated by Claude Code

@kherembourg kherembourg force-pushed the docs/readme-quickstart-harnesses branch from a8c5ca5 to eaa93ee Compare May 19, 2026 18:57
kherembourg pushed a commit that referenced this pull request May 19, 2026
Unlocks installation via OpenCode's native plugin spec — no symlinks, no
file copies, automatic updates.

- .opencode/INSTALL.md — prerequisites, opencode.json one-liner, usage,
  updating, troubleshooting (plugin not loading, Windows install issues
  with the npm --prefix workaround, skills not found).
- README — adds an OpenCode block in the per-tool setup section pointing
  at .opencode/INSTALL.md.

When the per-harness Quickstart restructure (#4) merges, the README also
gets an OpenCode entry in the new Quickstart section.
kherembourg pushed a commit that referenced this pull request May 19, 2026
Unlocks installation via OpenCode's native plugin spec — no symlinks, no
file copies, automatic updates.

- .opencode/INSTALL.md — prerequisites, opencode.json one-liner, usage,
  updating, troubleshooting (plugin not loading, Windows install issues
  with the npm --prefix workaround, skills not found).
- README — adds an OpenCode block in the per-tool setup section pointing
  at .opencode/INSTALL.md.

When the per-harness Quickstart restructure (#4) merges, the README also
gets an OpenCode entry in the new Quickstart section.
@kherembourg kherembourg force-pushed the docs/readme-quickstart-harnesses branch from eaa93ee to 23ac50c Compare May 19, 2026 19:01
…ocks

Aligns the README with the obra/superpowers layout: a single copy-paste-able
block per harness (Claude Code, Codex CLI/App, Cursor, Gemini CLI, OpenCode,
Copilot CLI, Mistral vibe, Windsurf, JetBrains, Continue), in that order.

The previous Options 1/2/3 (Claude Code plugin / install.sh / per-tool manual)
is folded into:
- the Quickstart blocks (Claude Code + per-tool one-liners)
- a dedicated 'Installation (legacy / all-in-one)' section that keeps the
  POSIX install.sh entry point intact.

Other sections (What It Does, Usage Examples, Project Structure, Supported
Platforms, Requirements, Contributing, Security, Changelog, License,
Resources) are preserved.
@kherembourg kherembourg force-pushed the docs/readme-quickstart-harnesses branch from 23ac50c to 873b9ee Compare May 19, 2026 19:04
@kherembourg kherembourg merged commit c661331 into main May 19, 2026
9 checks passed
@kherembourg kherembourg deleted the docs/readme-quickstart-harnesses branch May 19, 2026 19:05
kherembourg pushed a commit that referenced this pull request May 19, 2026
Unlocks installation via OpenCode's native plugin spec — no symlinks, no
file copies, automatic updates.

- .opencode/INSTALL.md — prerequisites, opencode.json one-liner, usage,
  updating, troubleshooting (plugin not loading, Windows install issues
  with the npm --prefix workaround, skills not found).
- README — adds an OpenCode block in the per-tool setup section pointing
  at .opencode/INSTALL.md.

When the per-harness Quickstart restructure (#4) merges, the README also
gets an OpenCode entry in the new Quickstart section.
kherembourg added a commit that referenced this pull request May 19, 2026
Unlocks installation via OpenCode's native plugin spec — no symlinks, no
file copies, automatic updates.

- .opencode/INSTALL.md — prerequisites, opencode.json one-liner, usage,
  updating, troubleshooting (plugin not loading, Windows install issues
  with the npm --prefix workaround, skills not found).
- README — adds an OpenCode block in the per-tool setup section pointing
  at .opencode/INSTALL.md.

When the per-harness Quickstart restructure (#4) merges, the README also
gets an OpenCode entry in the new Quickstart section.

Co-authored-by: Claude <noreply@anthropic.com>
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