Skip to content

docs: add agent plugin distribution roadmap#8

Merged
derek-palmer merged 4 commits into
mainfrom
update-spec
May 13, 2026
Merged

docs: add agent plugin distribution roadmap#8
derek-palmer merged 4 commits into
mainfrom
update-spec

Conversation

@derek-palmer
Copy link
Copy Markdown
Owner

@derek-palmer derek-palmer commented May 12, 2026

Summary

  • Moved the canonical spec into SPEC.md and updated the repo README to point at the spec/roadmap files.
  • Added a new requirement, phase, and task set for packaging codeforerunner as a skill/plugin for Claude, Codex, and similar agents.
  • Wrote a dedicated design doc covering the installer shape, package layout, ownership rules, and validation approach.

Testing

  • Not run (not requested).

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide on distributing the project as agent skills/plugins, covering layout, packaging conventions, installer behavior, validation tests, and open design decisions.
    • Consolidated the canonical phase/task tracker into the main spec and updated references across docs and handoff materials.
    • Updated the roadmap: introduced a skill/plugin distribution phase and moved thin runtime wrappers to a follow-up phase.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6bbd886e-67ae-4b63-9382-648461d1fdf1

📥 Commits

Reviewing files that changed from the base of the PR and between 0a901ac and 1bbadc7.

📒 Files selected for processing (1)
  • docs/agent-distribution-design.md

📝 Walkthrough

Walkthrough

This PR makes SPEC.md the canonical spec, adds SPEC.md phases/tasks for skill/plugin distribution and thin wrappers, introduces a new agent-distribution design doc, and updates repository docs to reference SPEC.md and the new design doc.

Changes

Agent Skill and Plugin Distribution Documentation

Layer / File(s) Summary
Specification framework for skill/plugin distribution
SPEC.md
Introduces agent distribution as planned phases P4 (skill/plugin distribution design) and P5 (thin wrappers). Adds constraint that packages route to prompt pack until runtime wrappers exist, invariant to avoid manual prompt discovery before installer support, and task updates for canonical sources, Codex/Claude packaging, and an idempotent installer.
Agent distribution architecture design
docs/agent-distribution-design.md
New design doc specifying repository/on-disk layout for canonical skill metadata and per-agent plugin artifacts, ownership boundaries (canonical vs installer-managed fenced sections), agent instruction responsibilities (prompt-pack routing, repo inspection, task prompt usage, config handling, reporting, safety), installer interface and idempotent behaviors (install/uninstall/doctor), packaging conventions (Codex, Claude Code, Generic), validation tests, and recorded open decisions.
Project documentation and reference alignment
README.md, AGENTS.md, docs/roadmap.md, codeforerunner_v2_handoff.md, docs/editor-agent-setup.md, docs/getting-started.md
Replaces codeforerunner_spec.md with SPEC.md across docs. README now lists SPEC.md and links docs/agent-distribution-design.md. Roadmap adds P4 (Skill/Plugin Distribution) and P5 (Thin Wrappers) with updated statuses and bullets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A spec takes root in markdown light,
Plugins queued for P4’s sight,
Thin wrappers wait in P5’s lane,
Docs aligned to speak the same,
Installers hum a careful refrain.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for agent plugin distribution roadmap, which is reflected across README, SPEC.md, and the new agent-distribution-design.md document.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-spec
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch update-spec

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 and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
SPEC.md (1)

383-397: ⚡ Quick win

Consider scoping Claude metadata under a codeforerunner-owned path.

Placing Claude metadata at .claude-plugin/plugin.json (root-level shared location) makes ownership-scoped uninstall riskier than the Codex path under plugins/codeforerunner/. Prefer a package-scoped path plus explicit managed-block insertion where needed to keep uninstall guarantees stronger.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@SPEC.md` around lines 383 - 397, Move Claude metadata out of the global
.claude-plugin/plugin.json into a package-scoped location (e.g.,
plugins/codeforerunner/.claude-plugin/plugin.json) and update install/uninstall
logic in bin/install-agent.js to detect, insert, and remove only package-scoped
managed blocks for Claude metadata (same pattern as
plugins/codeforerunner/.codex-plugin/plugin.json). Ensure install.sh and
install.ps1 still act as thin launchers that call bin/install-agent.js, and
implement explicit managed-block insertion/removal for the new Claude path so
uninstalls only affect the package-owned metadata.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@SPEC.md`:
- Around line 383-397: Move Claude metadata out of the global
.claude-plugin/plugin.json into a package-scoped location (e.g.,
plugins/codeforerunner/.claude-plugin/plugin.json) and update install/uninstall
logic in bin/install-agent.js to detect, insert, and remove only package-scoped
managed blocks for Claude metadata (same pattern as
plugins/codeforerunner/.codex-plugin/plugin.json). Ensure install.sh and
install.ps1 still act as thin launchers that call bin/install-agent.js, and
implement explicit managed-block insertion/removal for the new Claude path so
uninstalls only affect the package-owned metadata.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7ba0bad3-f70f-41a4-8539-8178bd2d557c

📥 Commits

Reviewing files that changed from the base of the PR and between ffcc76b and 3e20e88.

📒 Files selected for processing (6)
  • README.md
  • SPEC.md
  • docs/agent-distribution-design.md
  • docs/plan.md
  • docs/requirements.md
  • docs/tasks.md

# Conflicts:
#	README.md
#	SPEC.md
#	docs/plan.md
#	docs/requirements.md
#	docs/tasks.md
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/agent-distribution-design.md`:
- Around line 82-99: Update the four install snippets (the bash and pwsh wrapper
examples and the one-line curl/PowerShell lines referencing install.sh and
install.ps1) in docs/agent-distribution-design.md to explicitly state they are
illustrative, non-runnable future/planned examples (e.g., prefix with "Example —
planned/future usage" or add a short note like "Design example; installer not
yet available"), so readers won't assume the CLI or installers exist; ensure the
wording appears immediately above or inline with the snippets so the install.sh,
install.ps1, curl ... install.sh and irm ... install.ps1 lines are clearly
labeled as non-executable design examples.

In `@docs/roadmap.md`:
- Line 3: The roadmap's phase statuses (P0/P2/P3) in docs/roadmap.md are stale;
open SPEC.md to read the completion markers for P0, P2, and P3 and update the
corresponding entries in roadmap.md to "complete" (or the exact status used in
SPEC.md) so both documents match; also scan the block referenced around items
40–53 in roadmap.md and reconcile any other status mismatches with SPEC.md to
keep the two files consistent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cdf394be-dd81-4f70-ba4d-0a501c749856

📥 Commits

Reviewing files that changed from the base of the PR and between 3e20e88 and 620cd5a.

📒 Files selected for processing (8)
  • AGENTS.md
  • README.md
  • SPEC.md
  • codeforerunner_v2_handoff.md
  • docs/agent-distribution-design.md
  • docs/editor-agent-setup.md
  • docs/getting-started.md
  • docs/roadmap.md
✅ Files skipped from review due to trivial changes (4)
  • docs/getting-started.md
  • docs/editor-agent-setup.md
  • AGENTS.md
  • codeforerunner_v2_handoff.md

Comment thread docs/agent-distribution-design.md Outdated
Comment thread docs/roadmap.md
- Clarified that standalone wrappers and one-line install commands are planned features and not currently runnable.
- Updated the status of several roadmap items to reflect their completion, including Agent Config Exports and Human Docs, while adjusting the status of Thin Runtime Wrappers to planned.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/agent-distribution-design.md`:
- Line 63: Update the config filename referenced in the text from
`forerunner.config.yaml.example` to the canonical example name
`forerunner.config.yaml`; search for and replace any occurrences in this
document (docs/agent-distribution-design.md) and ensure related explanatory text
that describes the example config name or naming convention references
`forerunner.config.yaml` and the agreed convention (repo/product
`codeforerunner`, CLI/config `forerunner`) to keep terminology consistent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e60daacc-5c18-48c5-b685-d36df3bb4afd

📥 Commits

Reviewing files that changed from the base of the PR and between 620cd5a and 0a901ac.

📒 Files selected for processing (2)
  • docs/agent-distribution-design.md
  • docs/roadmap.md

Comment thread docs/agent-distribution-design.md Outdated
@derek-palmer derek-palmer merged commit eed7566 into main May 13, 2026
1 check passed
@coderabbitai coderabbitai Bot mentioned this pull request May 16, 2026
@derek-palmer derek-palmer deleted the update-spec branch May 16, 2026 18:28
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.

1 participant