docs: make README concise and agent-agnostic#144
Conversation
Reframe the README around Agent Skills (agentskills.io) usable by any coding agent rather than Claude Code specifically. Remove stale skill counts, lead installation with the agent-agnostic skills CLI, and collapse the ~35-row skill tables into a compact grouped headline list. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a top-level SKILLS.md cataloguing every active skill grouped by plugin, linked from the main README's Plugins table (each plugin name now links to its own README). Rewrite all 10 active plugin READMEs to be agent-agnostic: lead with the skills CLI, present Claude Code as one option, fold the /slash "Commands" sections into complete Skills tables, and drop skill counts. Adds a previously missing beagle-rust README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
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 (8)
✅ Files skipped from review due to trivial changes (7)
WalkthroughThe pull request rebrands all Beagle documentation from a Claude Code–specific plugin marketplace framing to an "Agent Skills" marketplace positioning. The top-level README is updated to present dual install paths: any coding agent via 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 `@README.md`:
- Line 51: The beagle-python plugin row in the table understates the plugin's
coverage by omitting PostgreSQL from its skills list, even though SKILLS.md
lists postgres-code-review under beagle-python. Update the technology list in
the beagle-python table row to include PostgreSQL alongside the existing
technologies (Python, FastAPI, SQLAlchemy, pytest) to accurately reflect the
plugin's actual capabilities.
🪄 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: 60fc9d0b-8a41-49c1-823d-4e3ef81a1771
📒 Files selected for processing (12)
README.mdSKILLS.mdplugins/beagle-analysis/README.mdplugins/beagle-core/README.mdplugins/beagle-docs/README.mdplugins/beagle-elixir/README.mdplugins/beagle-go/README.mdplugins/beagle-ios/README.mdplugins/beagle-python/README.mdplugins/beagle-react/README.mdplugins/beagle-rust/README.mdplugins/beagle-testing/README.md
Give every active plugin README an identical "## See Also" footer (catalog, beagle-core, marketplace) and drop the inconsistent per-plugin "Reference Material" subsections, which appeared in only 4 of 10 and duplicated each skill's own internal references. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The top-level README understated beagle-python's coverage; SKILLS.md and the postgres-code-review skill already list PostgreSQL. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a root llms.txt so web-crawling agents can discover beagle's docs and skills. Front-load the install command in the main README, rewrite vague plugin openers (core, testing, analysis, docs) with task/when-to-use framing, surface beagle-testing's browser/E2E support, and trim repetitive "Reviews ... for" descriptions in beagle-react to keyword-first phrasing. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 participant
Summary
Rewrites
README.mdto frame Beagle as an Agent Skills marketplace usable by any compatible coding agent rather than Claude Code specifically, while cutting it from 145 to ~87 lines by removing stale skill counts and duplicated content.Changes
Changed
npx skillsCLI; Claude Code is presented as one option among othersTotalrow)Removed
Totalrow) — these go staleMotivation
Beagle skills follow the Agent Skills spec and work with any compatible agent, but the README read as Claude Code-only. Skill counts and the exhaustive skill tables added length and maintenance burden without proportional value.
Testing
Manual Testing Steps
assets/Stafford_and_Snoopy.jpg,.codex/INSTALL.md,docs/README.codex.md) and every named plugin directory is presentChecklist