Skip to content

Add comprehensive Skills and Plugins documentation#339

Open
juanmichelini wants to merge 3 commits intomainfrom
add-skills-plugins-documentation
Open

Add comprehensive Skills and Plugins documentation#339
juanmichelini wants to merge 3 commits intomainfrom
add-skills-plugins-documentation

Conversation

@juanmichelini
Copy link

Overview

This PR adds comprehensive documentation for Skills and Plugins, improving the user experience across all skill levels (new, experienced, and power users).

Changes

1. Updated Keyword Skills Example

  • Changed example from 'yummy' to real-world skill
  • Added Info callout explaining context management with platform skills (GitHub/GitLab)
  • Justification: Real-world examples are more useful than toy examples; helps users understand practical applications

2. Added "Adding New Skills" Page

  • Explains how to use the /add-skill action
  • Documents skill storage locations for all platforms (CLI, SDK, GUI, Cloud)
  • Provides examples for various URL formats
  • Covers manual installation, updates, and authentication
  • Location: overview/skills/adding.mdx (under Skills section)
  • Justification: Users need a clear guide on how to add existing skills before they can use them

3. Added "Creating New Skills" Page

  • Comprehensive guide for creating custom skills
  • Sections: Determining Scope, Choosing Name and Triggers, Defining Body
  • Best practices: Numbered step workflows, references for large files, scripts for predictable steps
  • Includes common mistakes and complete examples
  • Location: overview/skills/creating.mdx (under Tips and Tricks)
  • Justification: Instead of repeating prompts, users should learn to create reusable skills; positioned in Tips and Tricks as it's a how-to guide

4. Added Plugins Overview Page

  • Explains what plugins are and how they bundle multiple components
  • Clear comparison table: Plugins vs Skills
  • Details on plugin structure and components (skills, hooks, MCP, agents, commands)
  • Platform-specific usage instructions
  • Complete examples and troubleshooting
  • Location: overview/plugins.mdx (same level as Skills in Common Features)
  • Justification: Plugins are a distinct concept from Skills; deserve their own top-level section for discoverability

5. Updated Navigation Structure

  • Added "Adding New Skills" to Skills section
  • Added "Creating New Skills" to Tips and Tricks section
  • Added "Plugins" at same level as Skills in Common Features
  • Justification: Logical organization that serves different user needs and discovery patterns

6. Enhanced Cross-References

  • Added links to new pages in Skills overview "Learn More" section
  • Added plugins reference in Creating Skills "Further Reading"
  • Bidirectional links between related pages
  • Justification: Improves navigation and helps users discover related content

User Flow Analysis

New Users (don't know the terms yet)

  • Journey: Overview → Keyword Examples → Adding Skills
  • ✅ Clear progression with real-world examples
  • ✅ Info callouts provide context without overwhelming

Experienced Users (trying things out, want to scratch an itch)

  • Journey: Direct access to Adding or Creating based on need
  • ✅ Quick Start sections for fast action
  • ✅ Practical examples throughout

Power Users (want to do things properly)

  • Journey: Creating → Plugins → SDK integration
  • ✅ Comprehensive best practices
  • ✅ Clear guidance on when to use each approach
  • ✅ Links to SDK documentation for advanced usage

Tone and Style

All new content maintains consistency with existing docs:

  • Imperative form for instructions
  • Third-person in frontmatter descriptions
  • Practical, actionable guidance
  • Real-world examples over abstract concepts
  • Progressive disclosure (simple → advanced)

Checklist

  • All changes have clear justifications
  • Flow reviewed for three user levels
  • Cross-references added for better navigation
  • Examples use real-world scenarios
  • Tone consistent with existing documentation
  • Navigation structure updated in docs.json

- Update keyword.mdx example to use github skill instead of yummy example
- Add context management note explaining github/gitlab skills triggering
- Create Adding New Skills guide explaining /add-skill action and storage locations
- Create Creating New Skills guide with best practices for scope, naming, triggers, and content
- Create Plugins overview explaining plugin structure and comparison with skills
- Update docs.json navigation to include new pages in appropriate sections
- Add cross-references between related documentation pages for better user flow

Co-authored-by: openhands <openhands@all-hands.dev>
- Add Tip callout in Quick Start section mentioning skill-creator
- Explain that users can ask OpenHands to 'create a skill' for guided assistance
- Helpful for new users learning best practices

Co-authored-by: openhands <openhands@all-hands.dev>
- Move skill-creator to be the first and primary method
- Present manual approach as alternative for those who prefer it
- Make it clear that skill-creator is the recommended starting point
- Better reflects that guided creation is simpler than manual setup

Co-authored-by: openhands <openhands@all-hands.dev>
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

Comments