diff --git a/docs/skillkit/App.tsx b/docs/skillkit/App.tsx index 0f3d6496..2502442f 100644 --- a/docs/skillkit/App.tsx +++ b/docs/skillkit/App.tsx @@ -6,6 +6,7 @@ import { Footer } from './components/Footer'; import { SkillGenerator } from './components/SkillGenerator'; import { SkillSubmitForm } from './components/SkillSubmitForm'; import { Commands } from './components/Commands'; +import { Documentation } from './components/Documentation'; const GITHUB_ICON = ( @@ -35,6 +36,12 @@ export default function App(): React.ReactElement { SKILLKIT
+ + Docs + +
+ +
+
diff --git a/docs/skillkit/components/Documentation.tsx b/docs/skillkit/components/Documentation.tsx new file mode 100644 index 00000000..8996d2a6 --- /dev/null +++ b/docs/skillkit/components/Documentation.tsx @@ -0,0 +1,479 @@ +import React, { useState } from 'react'; + +interface DocSection { + id: string; + title: string; + content: React.ReactNode; +} + +const CodeBlock = ({ children, language = 'bash' }: { children: string; language?: string }) => ( +
+    {children}
+  
+); + +const Table = ({ headers, rows }: { headers: string[]; rows: string[][] }) => ( +
+ + + + {headers.map((h, i) => ( + + ))} + + + + {rows.map((row, i) => ( + + {row.map((cell, j) => ( + + ))} + + ))} + +
{h}
{cell}
+
+); + +const sections: DocSection[] = [ + { + id: 'overview', + title: 'Overview', + content: ( +
+

+ SkillKit is a universal command-line interface (CLI) and programmatic toolkit for managing AI agent skills across 17+ AI coding platforms. It solves the fragmentation problem where each AI agent uses different skill formats and directory structures. +

+

Core Capabilities

+
    +
  • Skill Discovery - Browse 15,000+ skills from marketplace with AI-powered recommendations
  • +
  • Cross-Agent Translation - Automatically convert skills between 17 agent-specific formats
  • +
  • Team Collaboration - Share skills via .skills manifest files and publish to marketplace
  • +
+
+ ), + }, + { + id: 'installation', + title: 'Installation', + content: ( +
+

Quick Start

+ {`# Install globally via npm +npm install -g skillkit + +# Or use npx directly +npx skillkit --help + +# Or install via pnpm +pnpm add -g skillkit`} + +

Verify Installation

+ {`skillkit --version +skillkit --help`} + +

First Steps

+ {`# Initialize SkillKit in your project +skillkit init + +# Browse available skills +skillkit marketplace + +# Get AI-powered recommendations +skillkit recommend + +# Install skills from a source +skillkit install anthropics/skills`} +
+ ), + }, + { + id: 'architecture', + title: 'Architecture', + content: ( +
+

+ SkillKit employs a three-tier design with clean separation of concerns: +

+ +

System Tiers

+
    +
  • UI Tier - CLI commands, Terminal UI (OpenTUI-based), and documentation website
  • +
  • Core Logic Tier - @skillkit/core for business logic; @skillkit/agents for adapter implementations
  • +
  • Integration Tier - File systems, Git repositories, marketplace APIs, and 17+ AI agents
  • +
+ +

Monorepo Structure

+ {`skillkit-monorepo (pnpm workspace + Turbo) +├── apps/skillkit/ → Main CLI application (bin: skillkit, sk) +├── packages/core/ → Core business logic (no internal dependencies) +├── packages/agents/ → Agent adapters (depends on core) +├── packages/cli/ → Command implementations (depends on core, agents, tui) +├── packages/tui/ → Terminal UI (depends on core, agents) +└── docs/skillkit/ → Documentation website`} + +

Dependency Hierarchy

+
    +
  • @skillkit/core → Foundation (no SkillKit dependencies)
  • +
  • @skillkit/agents → Adapters (depends on core)
  • +
  • @skillkit/cli, @skillkit/tui → UIs (depend on core and agents)
  • +
  • skillkit app → Orchestrates all packages
  • +
+
+ ), + }, + { + id: 'agents', + title: 'Supported Agents', + content: ( +
+

+ SkillKit supports 17+ AI coding agents with automatic format translation: +

+ + + + ), + }, + { + id: 'commands', + title: 'CLI Commands', + content: ( +
+

Skill Management

+ {`skillkit install # Install skills from source +skillkit remove # Remove installed skill +skillkit update [skill] # Update skills +skillkit list # List installed skills +skillkit sync # Sync skills across agents +skillkit enable # Enable a skill +skillkit disable # Disable a skill`} + +

Discovery

+ {`skillkit recommend # AI-powered skill recommendations +skillkit marketplace # Browse marketplace skills +skillkit find # Search for skills +skillkit search # Search skill content`} + +

Translation

+ {`skillkit translate --from claude --to cursor +skillkit agent translate --target cursor +skillkit context sync # Sync context across agents`} + +

Team Collaboration

+ {`skillkit manifest init # Initialize .skills manifest +skillkit manifest add # Add source to manifest +skillkit manifest install # Install from manifest +skillkit publish # Publish skill to marketplace +skillkit cicd init # Setup CI/CD integration`} + +

Advanced

+ {`skillkit ui # Launch Terminal UI +skillkit workflow # Manage workflows +skillkit memory compress # Compress memory +skillkit memory export # Export memory +skillkit test # Run skill tests +skillkit validate # Validate skill format & quality`} +
+ ), + }, + { + id: 'configuration', + title: 'Configuration', + content: ( +
+

Project Configuration (skillkit.yaml)

+ {`version: 1 +agent: cursor +autoSync: true +enabledSkills: + - pdf + - xlsx +disabledSkills: + - deprecated-skill`} + +

Team Manifest (.skills)

+ {`# Team-wide skill sources +anthropics/skills +vercel-labs/agent-skills +./local-skills +owner/repo@v1.2.3`} + +

User Preferences (~/.skillkit/preferences.json)

+ {`{ + "lastSelectedAgents": ["claude", "cursor"], + "autoSync": true, + "marketplace": { + "lastRefresh": "2024-01-01T00:00:00Z" + } +}`} + +

File System Layout

+ {`project/ +├── .skillkit/ # Project config & memory +├── .claude/skills/ # Claude Code skills +├── .cursor/skills/ # Cursor AI skills +├── .github/skills/ # GitHub Copilot skills +├── skills/ # Universal format +└── .skills # Team manifest file + +~/.skillkit/ # Global user config +├── preferences.json +├── memory/ +└── cache/`} +
+ ), + }, + { + id: 'api', + title: 'API Reference', + content: ( +
+

Package Exports

+

@skillkit/core provides multiple entry points for programmatic use:

+ + {`import { findAllSkills, findSkill } from '@skillkit/core/discovery'; +import { parseSkillFile } from '@skillkit/core/parser'; +import { translateSkill } from '@skillkit/core/translator'; +import { syncContext } from '@skillkit/core/context'; +import { getRecommendations } from '@skillkit/core/recommend'; +import { evaluateSkillContent, getQualityGrade } from '@skillkit/core/quality';`} + +

Core Functions

+ {`// Discovery +findAllSkills(searchDirs: string[]): SkillInfo[] +findSkill(name: string, searchDirs: string[]): SkillInfo | null + +// Parsing +parseSkillFile(filePath: string): ParsedSkill +parseSkillContent(content: string): ParsedSkill + +// Translation +translateSkill(skill: ParsedSkill, targetAgent: AgentType): string +getAgentAdapter(agent: AgentType): AgentAdapter + +// Quality Evaluation +evaluateSkillContent(content: string): QualityScore +evaluateSkillFile(filePath: string): QualityScore +getQualityGrade(score: number): 'A' | 'B' | 'C' | 'D' | 'F' +isHighQuality(score: QualityScore): boolean + +// Recommendations +getRecommendations(context: ProjectContext): Recommendation[]`} + +

Type Definitions

+ {`interface SkillInfo { + name: string; + path: string; + agent: AgentType; + enabled: boolean; +} + +interface ParsedSkill { + name: string; + description?: string; + globs?: string[]; + triggers?: string[]; + content: string; + frontmatter: Record; +} + +interface QualityScore { + overall: number; + structure: StructureScore; + clarity: ClarityScore; + specificity: SpecificityScore; + advanced: AdvancedScore; + warnings: string[]; + suggestions: string[]; +} + +type AgentType = + | 'claude-code' | 'cursor' | 'codex' | 'gemini-cli' + | 'opencode' | 'antigravity' | 'amp' | 'clawdbot' + | 'droid' | 'github-copilot' | 'goose' | 'kilo' + | 'kiro-cli' | 'roo' | 'trae' | 'windsurf' | 'universal';`} +
+ ), + }, + { + id: 'skill-format', + title: 'Skill Format', + content: ( +
+

SKILL.md Structure

+

Skills use YAML frontmatter followed by markdown content:

+ + {`--- +name: my-skill +description: A helpful skill for coding tasks +globs: + - "**/*.ts" + - "**/*.tsx" +triggers: + - "when working with TypeScript" + - "when creating React components" +--- + +# My Skill + +## When to Use + +Use this skill when: +- Working with TypeScript files +- Creating React components + +## Instructions + +Follow these guidelines: + +1. Always use TypeScript strict mode +2. Prefer functional components + +\`\`\`typescript +function Example(): JSX.Element { + return
Hello
; +} +\`\`\` + +## Boundaries + +This skill should NOT: +- Modify configuration files without asking +- Delete existing code without confirmation`}
+ +

Quality Scoring

+

Skills are evaluated on four dimensions:

+
+ +

Grade Scale

+
+ + ), + }, + { + id: 'tech-stack', + title: 'Technology Stack', + content: ( +
+
+ +

Build Commands

+ {`pnpm build # Build all packages via Turbo +pnpm dev # Watch mode development +pnpm test # Unit tests via Vitest +pnpm test:e2e # End-to-end tests +pnpm typecheck # Type checking +pnpm clean # Remove build artifacts`} + + ), + }, +]; + +export function Documentation(): React.ReactElement { + const [activeSection, setActiveSection] = useState('overview'); + + const currentSection = sections.find(s => s.id === activeSection) || sections[0]; + + return ( +
+
+

Documentation

+

+ Complete guide to using SkillKit +

+ + Powered by DeepWiki + + + + +
+ +
+ + +
+
+

{currentSection.title}

+
+ {currentSection.content} +
+
+
+
+
+ ); +}