Skip to content

docs: document using skills directly in agents#90

Merged
subsy merged 1 commit intomainfrom
docs/skills-direct-usage
Jan 15, 2026
Merged

docs: document using skills directly in agents#90
subsy merged 1 commit intomainfrom
docs/skills-direct-usage

Conversation

@subsy
Copy link
Copy Markdown
Owner

@subsy subsy commented Jan 15, 2026 •
edited by coderabbitai bot
Loading

Summary

Changes

  • setup.mdx: Fixed skills path, added "Using Skills Directly" section with examples
  • introduction.mdx: Added "Flexible Usage" section explaining three approaches (TUI, direct skills, hybrid)
  • quick-start.mdx: Added alternative workflow section for direct skill usage
  • README.md: Added skills info to features list and usage section

Test plan

  • Verify MDX syntax is valid (no build errors)
  • Review rendered documentation on preview
  • Confirm skills path matches actual installation location (~/.claude/skills/)

Closes #87

Summary by CodeRabbit

Documentation

  • Expanded documentation to cover flexible usage modes: full TUI experience, direct skill integration in Claude Code, and hybrid workflows.
  • Added comprehensive guidance on using installed skills directly in agents without the TUI.
  • Included practical examples and troubleshooting steps for direct skill implementation.
  • Updated skills installation path information.

✏️ Tip: You can customize this high-level summary in your review settings.

@subsy
docs: document using skills directly in agents
aaffc12 
Addresses #87 - users can use ralph-tui skills directly in Claude Code
or OpenCode without needing the TUI interface.

Changes:
- Fix incorrect skills path (~/.claude-code → ~/.claude)
- Add "Using Skills Directly" section to setup.mdx
- Add "Flexible Usage" section to introduction.mdx
- Add alternative workflow to quick-start.mdx
- Update README with direct skills usage example

This documents the hybrid workflow: create PRDs in your agent where
you can reference files (@filename), then use ralph-tui run for
autonomous execution.
@vercel
Copy link
Copy Markdown

vercel bot commented Jan 15, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
ralph-tui Ready Ready Preview, Comment Jan 15, 2026 3:39pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 15, 2026 •
edited
Loading

Walkthrough

Documentation expanded across multiple files to explain how users can integrate PRD skills directly with Claude Code and OpenCode instead of exclusively through the TUI interface. Changes include new sections detailing direct skill usage, setup instructions, alternative workflows, and configuration guidance.

Changes

Cohort / File(s) Summary
Root Documentation
README.md		 Added "Flexible Skills" feature bullet; introduced "Using Skills Directly in Your Agent" section with slash commands and example workflows; expanded Custom Skills Directory guidance with file paths and SKILL.md requirements.
CLI Setup Guide
website/content/docs/cli/setup.mdx		 Updated skills installation path; added callout noting direct Claude Code integration; introduced new "Using Skills Directly" section with workflow examples, capability comparison, and reinforcing subsection in Troubleshooting area.
Getting Started
website/content/docs/getting-started/introduction.mdx, website/content/docs/getting-started/quick-start.mdx		 Added "Flexible Usage" section outlining three usage modes (Full TUI, Skills in Agent, Mixed approach); new "Alternative: Using Skills Directly in Your Agent" subsection with slash commands and hybrid workflow recommendations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A rabbit hops through docs with glee,
Skills now flow wild and free,
Claude and OpenCode unite,
No more TUI-only night,
Flexibility blooms for all to see! ✨

🚥 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 and concisely describes the main objective: documenting the capability to use skills directly in agents, which aligns perfectly with the core purpose of all changes across the PR.
Linked Issues check ✅ Passed The PR fully addresses issue #87 by documenting direct skill usage in Claude Code/OpenCode, explaining the TUI alternative, providing setup guidance with corrected skill paths, and enabling users to work within native agent interfaces with file references.
Out of Scope Changes check ✅ Passed All changes are scoped to addressing issue #87: documentation updates explain flexible usage modes, correct the skills installation path, and guide direct skill integration—no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7291a3 and aaffc12.

📒 Files selected for processing (4)
  • README.md
  • website/content/docs/cli/setup.mdx
  • website/content/docs/getting-started/introduction.mdx
  • website/content/docs/getting-started/quick-start.mdx
🔇 Additional comments (6)
website/content/docs/getting-started/introduction.mdx (1)

95-106: LGTM! Clear introduction to flexible usage options.

The new "Flexible Usage" section effectively communicates the three distinct approaches (TUI, direct skills, hybrid) and the tip callout helpfully explains where skills are installed. This aligns well with the PR objective of addressing issue #87 by documenting alternatives to the custom TUI.

website/content/docs/getting-started/quick-start.mdx (1)

97-116: LGTM! Good alternative workflow documentation.

The section clearly presents the direct skill usage option with practical benefits and a sensible hybrid workflow recommendation. The placement after the Beads section provides a natural progression of alternatives.

README.md (2)

73-73: LGTM! Concise feature addition.

The new bullet point succinctly captures the flexible skills capability.

143-155: LGTM! Good README addition for direct skill usage.

The section provides clear, actionable guidance for users who prefer to work directly in Claude Code. The information is consistent with the detailed documentation in setup.mdx.

website/content/docs/cli/setup.mdx (2)

133-143: LGTM! Correct skills path and helpful callout.

The skills installation table now shows the correct path (~/.claude/skills/) and the callout appropriately directs users to the new direct usage section.

213-263: LGTM! Comprehensive direct usage documentation.

The "Using Skills Directly" section thoroughly covers:

  • Clear use cases for when direct usage is preferred
  • Practical slash command examples
  • A step-by-step workflow example with realistic conversation snippets
  • A helpful comparison table explaining when to use each approach

This section directly addresses issue #87's feedback about the custom TUI being limiting.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

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.

coderabbitai[bot]
coderabbitai bot reviewed Jan 15, 2026
View reviewed changes
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: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
website/content/docs/cli/setup.mdx (1)

206-211: Inconsistent path in troubleshooting section.

The troubleshooting section still references the old ~/.claude-code/skills path, whilst the rest of the document correctly uses ~/.claude/skills/. This inconsistency could confuse users following the troubleshooting steps.

Proposed fix 
 ### "Permission denied" for skills

 Ensure the skills directory is writable:

 ```bash
 # Create skills directory if needed
-mkdir -p ~/.claude-code/skills
+mkdir -p ~/.claude/skills

 # Check permissions
-ls -la ~/.claude-code/
+ls -la ~/.claude/
</details>

</blockquote></details>

</blockquote></details>
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7291a3 and aaffc12.

📒 Files selected for processing (4)
  • README.md
  • website/content/docs/cli/setup.mdx
  • website/content/docs/getting-started/introduction.mdx
  • website/content/docs/getting-started/quick-start.mdx
🔇 Additional comments (6)
website/content/docs/getting-started/introduction.mdx (1)

95-106: LGTM! Clear introduction to flexible usage options.

The new "Flexible Usage" section effectively communicates the three distinct approaches (TUI, direct skills, hybrid) and the tip callout helpfully explains where skills are installed. This aligns well with the PR objective of addressing issue #87 by documenting alternatives to the custom TUI.

website/content/docs/getting-started/quick-start.mdx (1)

97-116: LGTM! Good alternative workflow documentation.

The section clearly presents the direct skill usage option with practical benefits and a sensible hybrid workflow recommendation. The placement after the Beads section provides a natural progression of alternatives.

README.md (2)

73-73: LGTM! Concise feature addition.

The new bullet point succinctly captures the flexible skills capability.

143-155: LGTM! Good README addition for direct skill usage.

The section provides clear, actionable guidance for users who prefer to work directly in Claude Code. The information is consistent with the detailed documentation in setup.mdx.

website/content/docs/cli/setup.mdx (2)

133-143: LGTM! Correct skills path and helpful callout.

The skills installation table now shows the correct path (~/.claude/skills/) and the callout appropriately directs users to the new direct usage section.

213-263: LGTM! Comprehensive direct usage documentation.

The "Using Skills Directly" section thoroughly covers:

  • Clear use cases for when direct usage is preferred
  • Practical slash command examples
  • A step-by-step workflow example with realistic conversation snippets
  • A helpful comparison table explaining when to use each approach

This section directly addresses issue #87's feedback about the custom TUI being limiting.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

@subsy subsy merged commit 87bbcc9 into main Jan 15, 2026
6 checks passed
@subsy subsy deleted the docs/skills-direct-usage branch January 15, 2026 15:43
This was referenced Jan 18, 2026
Merged
Merged
sakaman pushed a commit to sakaman/ralph-tui that referenced this pull request Feb 15, 2026
@subsy
Merge pull request subsy#90 from subsy/docs/skills-direct-usage
671e54d 
docs: document using skills directly in agents
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Why making a custom interface when can just give the skills to actual opencode / claude tui ?

1 participant

@subsy