docs: add agent plugin distribution roadmap#8
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis 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. ChangesAgent Skill and Plugin Distribution Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
SPEC.md (1)
383-397: ⚡ Quick winConsider 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 underplugins/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
📒 Files selected for processing (6)
README.mdSPEC.mddocs/agent-distribution-design.mddocs/plan.mddocs/requirements.mddocs/tasks.md
# Conflicts: # README.md # SPEC.md # docs/plan.md # docs/requirements.md # docs/tasks.md
There was a problem hiding this comment.
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
📒 Files selected for processing (8)
AGENTS.mdREADME.mdSPEC.mdcodeforerunner_v2_handoff.mddocs/agent-distribution-design.mddocs/editor-agent-setup.mddocs/getting-started.mddocs/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
- 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.
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/agent-distribution-design.mddocs/roadmap.md
Summary
SPEC.mdand updated the repo README to point at the spec/roadmap files.Testing
Summary by CodeRabbit