mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-19 02:17:09 +00:00
- Slim README from 777 to 214 lines for better readability - Adjust value prop: emphasize sync, bidirectional, team over AI-native - Split detailed content into docs/ directory: - install.md: init, install, update, upgrade, uninstall - sync.md: sync, pull, push, backup, restore with diagrams - targets.md: target management with flowcharts - cross-machine.md: multi-machine sync setup - team-edition.md: tracked repos, nested skills, team sharing - configuration.md: config file reference - faq.md: doctor command, FAQ, troubleshooting - Add docs/README.md as documentation index - Remove /docs/ from .gitignore
3.5 KiB
3.5 KiB
Skillshare Documentation
Welcome to the skillshare documentation. Choose a topic below.
Quick Links
| I want to... | Go to |
|---|---|
| Get started | README |
| Install a skill | install.md |
| Sync skills to targets | sync.md |
| Manage targets | targets.md |
| Sync across machines | cross-machine.md |
| Share skills with team | team-edition.md |
| Configure skillshare | configuration.md |
| Troubleshoot issues | faq.md |
Documentation Structure
docs/
├── README.md ← You are here
├── install.md ← Install, update, upgrade, uninstall skills
├── sync.md ← Sync, pull, push, backup, restore
├── targets.md ← Add, remove, configure targets
├── cross-machine.md ← Sync across multiple computers
├── team-edition.md ← Tracked repos, nested skills, team sharing
├── configuration.md ← Config file reference
└── faq.md ← FAQ & troubleshooting
Command Quick Reference
| Command | What it does | Docs |
|---|---|---|
init |
First-time setup | install.md |
install |
Add a skill | install.md |
uninstall |
Remove a skill | install.md |
update |
Update a skill | install.md |
upgrade |
Upgrade CLI/skill | install.md |
sync |
Push to targets | sync.md |
pull |
Pull from target | sync.md |
push |
Push to git remote | sync.md |
backup |
Backup targets | sync.md |
restore |
Restore from backup | sync.md |
target |
Manage targets | targets.md |
list |
List skills | install.md |
status |
Show sync state | sync.md |
diff |
Show differences | sync.md |
doctor |
Diagnose issues | faq.md |
Core Concepts
Source vs Targets
┌─────────────────────────────────────────┐
│ SOURCE (edit here) │
│ ~/.config/skillshare/skills/ │
│ │
│ my-skill/ another/ _team-repo/ │
└─────────────────────────────────────────┘
│
│ skillshare sync
▼
┌─────────────────────────────────────────┐
│ TARGETS │
│ ~/.claude/skills/ (symlinks) │
│ ~/.cursor/skills/ (symlinks) │
│ ~/.codex/skills/ (symlinks) │
└─────────────────────────────────────────┘
- Source: Single directory where you edit skills
- Targets: AI CLI skill directories (symlinked from source)
- Sync: Creates/updates symlinks from source to targets
Sync Modes
| Mode | How it works |
|---|---|
merge |
Each skill symlinked individually. Local skills preserved. (default) |
symlink |
Entire directory is one symlink. All targets identical. |
See sync.md for details.