Skip to content

docs: complete the marketplace setup steps - #181

Merged
CybotTM merged 2 commits into
mainfrom
docs/install-instructions
Sep 8, 2026
Merged

docs: complete the marketplace setup steps#181
CybotTM merged 2 commits into
mainfrom
docs/install-instructions

Conversation

@CybotTM

@CybotTM CybotTM commented Sep 7, 2026

Copy link
Copy Markdown
Member

The README named the catalog correctly, but stopped one step short of a working setup: it documented /plugin marketplace add netresearch/claude-code-marketplace and never the /plugin install line that has to follow it. Following it left you with a registered marketplace and no plugin.

/plugin marketplace add netresearch/claude-code-marketplace
/plugin install github-project@netresearch-claude-code-marketplace

The install target is the catalog entry namegithub-project here — which is not always the repo name, and the right-hand side is the marketplace name rather than owner/repo.

Also added

The marketplace-free route, which is supported rather than a workaround. Claude Code 2.1.157: "Plugins in .claude/skills directories are now automatically loaded, no marketplace required." A clone under ~/.claude/skills/github-project loads as github-project@skills-dir with hooks, agents and commands intact.

Context

This came out of netresearch/retro-skill#90, where a user found the documented steps unusable. That repo pointed marketplace add at itself, which fails outright; this repo was never broken, only incomplete. The shared template both came from is fixed in netresearch/skill-repo-skill#291.

markdownlint-cli2 clean.

Review round

Review on this PR found four defects in the section above, all fixed here:

  • The limitation note sat inside the bash fence under "Git Clone", so it rendered as shell input and would be copied along with the command. It now follows the npx example, which is what it is about.
  • git clone into ~/.claude/skills/<name> fails on a fresh setup where that parent does not exist. mkdir -p ~/.claude/skills precedes it.
  • "Update with git pull" ran wherever the reader happened to stand. It now names the directory and says a new session is needed for the change to load.
  • The sentence claimed hooks and commands unconditionally. It now names only what this repository actually ships.

One finding was declined: that the skills-directory route should not be published, because .claude-plugin/plugin.json lists only skills. hooks/hooks.json is discovered by convention rather than declared — of twelve installed plugins carrying a hooks/ directory, Anthropic's own included, none declares a hooks key. The key's absence proves nothing, so the route stays.

Assisted by claude-code:claude-opus-5 — Session

@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: a2766798-0f70-472c-83e7-6e74e3f8724c

📥 Commits

Reviewing files that changed from the base of the PR and between f61861e and 9dc35e1.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README adds the Claude Code plugin installation command. It also documents direct Git clone installation under ~/.claude/skills/github-project, automatic loading, updates with git pull, and removal by deleting the directory.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 9dc35

The installation documentation adds Marketplace and direct-clone setup instructions without changing runtime behavior. The documented identifiers and repository layout align with the supplied metadata context, so the change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly describes the primary change: completing the marketplace setup instructions in the README.
Description check ✅ Passed The description directly explains the added marketplace install command and the marketplace-free installation route documented in the README.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/install-instructions
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/install-instructions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 7, 2026
@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@CybotTM
CybotTM marked this pull request as ready for review September 8, 2026 21:22
Copilot AI lite review requested due to automatic review settings September 8, 2026 21:22

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

The README named the catalog correctly but stopped one step short: it never
documented the `/plugin install` line, so following it left you with a
registered marketplace and no plugin. The install target is the catalog entry
name `github-project`, which is not always the repo name.

Also documents the marketplace-free route from Claude Code 2.1.157 ("Plugins in
.claude/skills directories are now automatically loaded, no marketplace
required"), which loads hooks, agents and commands in place.

Canonical template corrected in netresearch/skill-repo-skill#291.

Assisted-by: claude-code:claude-opus-5
Agent-Session: https://claude.ai/code/session_01L94yEWSBvuUkLqLpVbMqRh
Agent-Host: 0493f0
Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
@CybotTM
CybotTM force-pushed the docs/install-instructions branch from 89e3daa to 9dc35e1 Compare September 8, 2026 21:23
Review on this PR found four defects in the section it adds:

- The limitation note sat inside the `bash` fence under "Git Clone", so it rendered as shell input and would be copied along with the command. It now sits after the npx example, which is what it is about.
- `git clone` into `~/.claude/skills/<name>` fails on a fresh setup where that parent does not exist; `mkdir -p ~/.claude/skills` precedes it.
- "Update with `git pull`" ran wherever the reader happened to stand. It now names the directory and says a new session is needed for the change to load.
- The sentence claimed hooks and commands unconditionally. It now names only what this repository actually ships.

The skills-directory route itself is kept. The review argued it should be dropped because `.claude-plugin/plugin.json` lists only `skills`, but that key is not how hooks are discovered: of twelve installed plugins carrying a `hooks/` directory — Anthropic's own among them — none declares `hooks` in its `plugin.json`. `hooks/hooks.json` is loaded by convention, so its absence from the manifest proves nothing.

Assisted-by: claude-code:claude-opus-5
Agent-Session: https://claude.ai/code/session_01Gcm3GRuYBxJGtyj7qviJF8
Agent-Host: 0493f0
Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
@sonarqubecloud

sonarqubecloud Bot commented Sep 8, 2026

Copy link
Copy Markdown

@CybotTM

CybotTM commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

Copilot review unavailable — self-review below.

The copilot_code_review ruleset cannot deliver: Copilot is out of review quota account-wide, so no review of its can land on this head however often it is requested. This is not an unreviewed PR — CodeRabbit reviewed it, and its findings on this repository are answered and resolved above. Recording the rest of the check here rather than merging silently or waiting on a quota that may not return this month.

What this change is. A six-line correction to the install section, identical in shape across the rollout: the limitation note moved out of the bash fence, mkdir -p ~/.claude/skills added before the clone, the update command given its directory and a session-restart note, and the component sentence narrowed to what this repository actually ships.

How it was verified. The edit was produced by a script that asserts every anchor before replacing it, so a missed anchor aborts instead of silently doing nothing, and its output was compared byte-for-byte against a diff written and reviewed by hand first. The per-repository component sentence was cross-checked against the actual presence of hooks/, commands/ and agents/ in each tree rather than against the manifest. Only README.md is touched, verified in every worktree before committing.

One finding was declined, with evidence. The review argued the skills-directory route should not be published, because .claude-plugin/plugin.json lists only skills. hooks/hooks.json is discovered by convention rather than declared: of twelve installed plugins carrying a hooks/ directory — Anthropic's own claude-plugins-official among them — none declares a hooks key. The key's absence proves nothing about what loads.

Scope of this attestation. One review of one change applied across the repositories that carry it, not twenty independent reviews. The diffs differ only in the repository name and the component list, and both were checked per repository.

@CybotTM

CybotTM commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

Self-review: e139f67

The review this pull request demands is unsatisfiable (Copilot quota wall or repeated bot failures on this head). Per the documented fallback, the diff on this head was reviewed by the PR author; this comment is the on-the-record attestation the merge gate reads back. It stops matching on the next push.

@CybotTM
CybotTM merged commit 98e3373 into main Sep 8, 2026
21 checks passed
@CybotTM
CybotTM deleted the docs/install-instructions branch September 8, 2026 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants