Skip to content

Commit 4e04562

Browse files
committed
feat: Add comprehensive getting started documentation and setup scripts
- Fix path references in all command files for plugin installation - Remove 'skills' field from plugin.json per Claude Code docs - Add prominent 'New? Start here' section to README - Create 5 documentation files (GETTING_STARTED, FIRST_CONVERSATIONS, TROUBLESHOOTING, WALKTHROUGHS, FAQ) - Create 3 safe setup scripts (verify, diagnose, demo) - Include ML/AI examples throughout (6th example + 5th walkthrough) - Total: 3,535 lines of docs + 620 lines of scripts Addresses user feedback that cc-polymath is hard to get started with. All scripts are safe and non-destructive (read-only operations).
1 parent 5da1c61 commit 4e04562

24 files changed

Lines changed: 4226 additions & 52 deletions

.claude-plugin/plugin.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,5 @@
3939
"dspy",
4040
"context-efficient"
4141
],
42-
"commands": "./commands",
43-
"skills": "./skills"
42+
"commands": "./commands"
4443
}

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,27 @@
66

77
**Context-efficient development knowledge via progressive skill discovery**
88

9-
> **Claude Code Plugin**: Install with `/plugin install https://github.com/rand/cc-polymath`
9+
## 🚀 New? Start Here
10+
11+
**Install in 30 seconds**:
12+
```
13+
/plugin install https://github.com/rand/cc-polymath
14+
```
15+
16+
**Your first 3 commands**:
17+
```bash
18+
/skills # See what's recommended for your project
19+
/discover-frontend # Load React, Next.js, TypeScript skills (example)
20+
bash ~/.claude/plugins/cc-polymath/scripts/verify-install.sh # Verify installation
21+
```
22+
23+
**Learn more**:
24+
- 📖 **[Getting Started Guide](docs/GETTING_STARTED.md)** - 5-minute quick start
25+
- 💬 **[Example Conversations](docs/FIRST_CONVERSATIONS.md)** - See it in action
26+
- 🆘 **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues & solutions
27+
-**[FAQ](docs/FAQ.md)** - Quick answers
28+
29+
---
1030

1131
This repository solves a tradeoff problem: how to give Claude Code access to comprehensive development knowledge without overwhelming its context window on boot. The solution is atomic, composable skills organized through a multi-tier discovery system.
1232

commands/discover-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load API design skills (REST, GraphQL, auth, rate limiting)
77
Load the API design gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-api/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-api/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load container skills (Docker, Kubernetes, security, optimization)
77
Load the containers gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-containers/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-containers/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load database skills (PostgreSQL, MongoDB, Redis, optimization)
77
Load the database gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-database/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-database/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load debugging skills (GDB, LLDB, profiling, memory analysis)
77
Load the debugging gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-debugging/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-debugging/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-diagrams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load diagram skills (Mermaid flowcharts, sequence, ER, architecture
77
Load the diagrams gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-diagrams/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-diagrams/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load frontend skills (React, Next.js, TypeScript, state management)
77
Load the frontend gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-frontend/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-frontend/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-infrastructure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load infrastructure skills (Terraform, IaC, cloud platforms, contai
77
Load the infrastructure gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-infrastructure/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-infrastructure/SKILL.md
1111
```
1212

1313
This activates skills for:

commands/discover-ml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Load ML/AI skills (DSPy, training, RAG, embeddings, evaluation)
77
Load the ML/AI gateway skill:
88

99
```bash
10-
cat ~/.claude/skills/discover-ml/SKILL.md
10+
cat ~/.claude/plugins/cc-polymath/skills/discover-ml/SKILL.md
1111
```
1212

1313
This activates skills for:

0 commit comments

Comments
 (0)