docs: add agent skills page and llms.txt callout#815
Conversation
Document the miren-skills plugin with installation instructions for Claude Code, Codex, Amp, Pi, and OpenCode. Add a tip to the intro page pointing AI coding agents at llms.txt and the skills repo.
|
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)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR adds a new Agent Skills guide (agent-skills.md) documenting installation and usage for Claude Code, Codex, Amp, Pi, and OpenCode, and describing four Miren skills: use-miren, app-setup, app-health, and cluster-health. It also documents command discovery via miren help and notes -C targeting. The intro page gets a tip callout pointing to LLM docs and the agent skills repo, and the site sidebar adds the agent-skills entry under Resources. 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: 3
🤖 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/docs/agent-skills.md`:
- Around line 33-35: Update the fenced code block containing "skill: add
https://github.com/mirendev/miren-skills" to include a language specifier (e.g.,
add ```text before the block) so the block becomes a labeled code fence and
satisfies linting and clarity requirements.
- Around line 25-26: Replace the placeholder path "/path/to/miren-skills/" in
the docs' mkdir/cp example with a complete, concrete installation workflow: show
the git clone command for the miren-skills repo (git clone
https://github.com/mirendev/miren-skills), cd into miren-skills, then run the cp
command to copy .agents/skills into the user's ~/.agents/skills directory;
alternatively show the common-case variant that assumes the repo was cloned to
~/miren-skills and uses cp -r ~/miren-skills/.agents/skills/* ~/.agents/skills/;
apply the same replacement for the second occurrence referenced in the comment
(lines 46-47).
- Line 11: The markdown link for "Pi" currently points to the incorrect URL
"https://github.com/anthropics/pi"; update that link in the docs line containing
"The skills work with ... Pi ..." to the correct Pi site or repo (for example
replace the URL with "https://pi.dev/" or the official Pi repository) so the
"Pi" anchor points to the valid resource; leave the other platform links (Claude
Code, Codex, Amp, OpenCode) unchanged.
🪄 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: 833dcc30-520a-4009-b138-7208535f51cd
📒 Files selected for processing (3)
docs/docs/agent-skills.mddocs/docs/intro.mddocs/sidebars.ts
Clarify that skills make docs actionable but the docs remain the authoritative reference — addresses MIR-1052 requirement.
phinze
left a comment
phinze
left a comment
There was a problem hiding this comment.
Agree w/ CR on bad pi linky + one inline comment, otherwise looks good!
| ```bash | ||
| miren help --commands # list all commands | ||
| miren help app.list # help for a specific command (use . for spaces) | ||
| miren help "app list" # alternative: quote the command |
There was a problem hiding this comment.
Actually just fixed this in #812 to not be so awkward for subcommands. miren help app list works normally w/o dots or quotes
- Fix Pi link to point to pi.dev instead of nonexistent GitHub repo - Replace placeholder paths with git clone workflow for Codex and OpenCode - Add language specifier to Amp code block - Simplify miren help examples (dots/quotes no longer needed per #812)
2 participants
Summary
llms.txt/llms-full.txtand the skills repoFixes MIR-1052