mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 20:34:19 +00:00
feat(website): complete website revamp — Diátaxis IA, blog, recipes, quickstarts
Restructure the entire documentation site following the Diátaxis framework (Learn / How-to / Understand / Reference) with new content across 110 files. ## Information Architecture (M1) - Move all docs to Diátaxis directory structure (learn/, how-to/, understand/, reference/) - Add client-redirects plugin for old URL compatibility - Rewrite sidebar, navbar, and footer to match new IA - Update all internal cross-references ## Homepage + Quickstarts (M2) - Add scenario entry cards to homepage with hand-drawn design - 5 quickstart pages: Claude Code, GitHub Copilot (with copy mode recommendation), Codex, Multiple Tools, Dev Containers, Playground ## Blog + Changelog (M3) - Enable Docusaurus blog plugin with authors.yml - 5 blog posts: 5-min tutorial, managing 50+ skills, skillshare vs vercel/skills comparison, team sharing patterns, write your first skill - Static /changelog page from CHANGELOG.md ## Recipes + Philosophy (M4) - 5 recipe pages: CI/CD validation, enterprise skills, project setup, cross-machine sync, team onboarding - 3 philosophy pages: why-local-first, security-first, sync-modes-explained ## Content Polish - Cross-validate all content against CLI source (19 inaccuracies fixed) - Lowercase "skillshare" throughout (avoid brand conflict with Skillshare Inc.) - Add registry.yaml to file structure and Key Paths docs - Highlight multi-platform git support (GitHub, GitLab, Bitbucket, Gitea, Azure DevOps, AtomGit, Codeberg) - Standardize brew install command - Add AsciinemaPlayer component (cast recordings pending)
This commit is contained in:
@@ -15,11 +15,15 @@ Get your skills synced in 5 minutes.
|
||||
|
||||
## Step 1: Install skillshare
|
||||
|
||||
**Homebrew:**
|
||||
**Homebrew (macOS / Linux):**
|
||||
```bash
|
||||
brew install skillshare
|
||||
```
|
||||
|
||||
:::note
|
||||
Homebrew releases may lag behind the latest version by a few days. For the newest release, use the install script below.
|
||||
:::
|
||||
|
||||
:::note
|
||||
All install methods include the web dashboard. `skillshare ui` automatically downloads UI assets on first launch — no extra setup needed.
|
||||
:::
|
||||
@@ -127,9 +131,9 @@ You should see:
|
||||
|
||||
## What's Next?
|
||||
|
||||
- [Create your own skill](/docs/guides/creating-skills)
|
||||
- [Sync across machines](/docs/guides/cross-machine-sync)
|
||||
- [Organization-wide skills](/docs/guides/organization-sharing)
|
||||
- [Create your own skill](/docs/how-to/daily-tasks/creating-skills)
|
||||
- [Sync across machines](/docs/how-to/sharing/cross-machine-sync)
|
||||
- [Organization-wide skills](/docs/how-to/sharing/organization-sharing)
|
||||
|
||||
## What Just Happened?
|
||||
|
||||
@@ -137,7 +141,7 @@ Here's what skillshare did behind the scenes:
|
||||
|
||||
1. **`init`** — Created `~/.config/skillshare/config.yaml` and `~/.config/skillshare/skills/`. Auto-detected your AI CLIs (Claude, Cursor, etc.) and added them as targets.
|
||||
|
||||
2. **`install`** — Cloned the skill from GitHub into your source directory (`~/.config/skillshare/skills/`). Ran a security audit automatically.
|
||||
2. **`install`** — Cloned the skill from the Git repository into your source directory (`~/.config/skillshare/skills/`). Ran a security audit automatically. Works with GitHub, GitLab, Bitbucket, Gitea, Azure DevOps, and any HTTPS/SSH Git host.
|
||||
|
||||
3. **`sync`** — Applied each target's configured sync mode (default is merge, which creates per-skill symlinks). For example:
|
||||
```
|
||||
@@ -156,10 +160,10 @@ skillshare target <name> --mode copy
|
||||
skillshare sync
|
||||
```
|
||||
|
||||
See [Sync Modes](/docs/concepts/sync-modes) for the decision matrix and trade-offs.
|
||||
See [Sync Modes](/docs/understand/sync-modes) for the decision matrix and trade-offs.
|
||||
|
||||
## See Also
|
||||
|
||||
- [Core Concepts](/docs/concepts) — Understand source, targets, and sync modes
|
||||
- [Daily Workflow](/docs/workflows/daily-workflow) — How to use skillshare day-to-day
|
||||
- [Creating Skills](/docs/guides/creating-skills) — Write your own skills
|
||||
- [Core Concepts](/docs/understand) — Understand source, targets, and sync modes
|
||||
- [Daily Workflow](/docs/how-to/daily-tasks/daily-workflow) — How to use skillshare day-to-day
|
||||
- [Creating Skills](/docs/how-to/daily-tasks/creating-skills) — Write your own skills
|
||||
|
||||
@@ -145,6 +145,6 @@ skillshare restore cursor
|
||||
|
||||
## See Also
|
||||
|
||||
- [Daily Workflow](/docs/workflows/daily-workflow) — Your day-to-day after migration
|
||||
- [Cross-Machine Sync](/docs/guides/cross-machine-sync) — Sync to other machines
|
||||
- [Core Concepts](/docs/concepts) — How source and targets work
|
||||
- [Daily Workflow](/docs/how-to/daily-tasks/daily-workflow) — Your day-to-day after migration
|
||||
- [Cross-Machine Sync](/docs/how-to/sharing/cross-machine-sync) — Sync to other machines
|
||||
- [Core Concepts](/docs/understand) — How source and targets work
|
||||
|
||||
@@ -13,7 +13,7 @@ Get skillshare running in minutes. Choose your starting point:
|
||||
| Set up skillshare from scratch | [First Sync](./first-sync.md) — install, init, and sync in 5 minutes |
|
||||
| I already have skills in Claude/Cursor/etc. | [From Existing Skills](./from-existing-skills.md) — consolidate and unify |
|
||||
| I know skillshare, just need command syntax | [Quick Reference](./quick-reference.md) — cheat sheet |
|
||||
| Try without installing anything | [Docker Playground](/docs/guides/docker-sandbox#playground) — `make playground` in cloned repo |
|
||||
| Try without installing anything | [Docker Playground](/docs/how-to/advanced/docker-sandbox#playground) — `make playground` in cloned repo |
|
||||
|
||||
## The 3-Step Pattern
|
||||
|
||||
@@ -38,6 +38,6 @@ After setup, behavior depends on mode:
|
||||
|
||||
After you're set up:
|
||||
|
||||
- [Core Concepts](/docs/concepts) — Understand source, targets, and sync modes
|
||||
- [Daily Workflow](/docs/workflows/daily-workflow) — How to use skillshare day-to-day
|
||||
- [Commands Reference](/docs/commands) — Full command reference
|
||||
- [Core Concepts](/docs/understand) — Understand source, targets, and sync modes
|
||||
- [Daily Workflow](/docs/how-to/daily-tasks/daily-workflow) — How to use skillshare day-to-day
|
||||
- [Commands Reference](/docs/reference/commands) — Full command reference
|
||||
|
||||
@@ -143,6 +143,7 @@ make playground-down # stop container
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `~/.config/skillshare/config.yaml` | Configuration file |
|
||||
| `~/.config/skillshare/registry.yaml` | Installed skill registry (auto-managed) |
|
||||
| `~/.config/skillshare/skills/` | Source directory |
|
||||
| `~/.local/state/skillshare/logs/` | Operation and audit logs |
|
||||
| `~/.local/share/skillshare/backups/` | Backup directory |
|
||||
@@ -160,5 +161,5 @@ make playground-down # stop container
|
||||
|
||||
## See Also
|
||||
|
||||
- [Commands Reference](/docs/commands) — Full command documentation
|
||||
- [Concepts](/docs/concepts) — Core concepts explained
|
||||
- [Commands Reference](/docs/reference/commands) — Full command documentation
|
||||
- [Concepts](/docs/understand) — Core concepts explained
|
||||
|
||||
Reference in New Issue
Block a user