refactor(wds): Split lessons into checklist and full lesson format
Each lesson now has two files: - checklist.md: Quick action list with checkboxes - lesson.md: Full detailed explanation Overview updated to show both options per lesson.
This commit is contained in:
parent
cb2b9c92a6
commit
4335c0fc54
|
|
@ -0,0 +1,70 @@
|
||||||
|
# Lesson 01: GitHub Setup - Quick Checklist
|
||||||
|
|
||||||
|
**⏱️ 15-20 minutes**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Create GitHub Account
|
||||||
|
|
||||||
|
- [ ] Go to **https://github.com**
|
||||||
|
- [ ] Click **"Sign up"**
|
||||||
|
- [ ] Enter email, password, username (professional: `yourname-designer`)
|
||||||
|
- [ ] Verify email
|
||||||
|
- [ ] ✅ Log in successful
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Choose Your Scenario
|
||||||
|
|
||||||
|
- [ ] **A:** Starting new project → Continue below
|
||||||
|
- [ ] **B:** Joining existing → Skip to "Join Existing" section
|
||||||
|
- [ ] **C:** Just learning → Skip to [Lesson 02](../lesson-02-install-ide/checklist.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Create New Repository
|
||||||
|
|
||||||
|
- [ ] Click profile icon → **"Your repositories"** → **"New"**
|
||||||
|
|
||||||
|
### Decide: Single or Separate?
|
||||||
|
|
||||||
|
**Single repo (specs + code together):**
|
||||||
|
- [ ] Name: `my-project` (e.g., `dog-walker-app`)
|
||||||
|
- [ ] For: Small team, building yourself, simple communication
|
||||||
|
|
||||||
|
**Separate specs repo (specs only):**
|
||||||
|
- [ ] Name: `my-project-specs` (e.g., `dog-walker-app-specs`)
|
||||||
|
- [ ] For: Corporate, many developers, clear handoff
|
||||||
|
|
||||||
|
### Repository Settings
|
||||||
|
|
||||||
|
- [ ] Name: `_____________` (lowercase-with-hyphens)
|
||||||
|
- [ ] Description: One-liner about project
|
||||||
|
- [ ] Public or Private
|
||||||
|
- [ ] ☑️ **Check "Initialize with README"**
|
||||||
|
- [ ] Click **"Create repository"**
|
||||||
|
- [ ] ✅ Repository created
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Join Existing Repository
|
||||||
|
|
||||||
|
- [ ] Ask owner for access (email template in lesson.md)
|
||||||
|
- [ ] Check email for GitHub invitation
|
||||||
|
- [ ] Click **"Accept invitation"**
|
||||||
|
- [ ] Check repo name (ends in `-specs`? Separate repo)
|
||||||
|
- [ ] Browse repo structure (has `docs/`? WDS already!)
|
||||||
|
- [ ] ✅ Access granted
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Step
|
||||||
|
|
||||||
|
✅ GitHub setup complete!
|
||||||
|
|
||||||
|
**[→ Lesson 02: IDE Installation](../lesson-02-install-ide/checklist.md)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Need more detail?** See [full lesson explanation](lesson.md)
|
||||||
|
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
# Lesson 02: IDE Installation - Quick Checklist
|
||||||
|
|
||||||
|
**⏱️ 10 minutes**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Choose IDE
|
||||||
|
|
||||||
|
- [ ] **Cursor** (recommended for AI work) → https://cursor.sh
|
||||||
|
- [ ] **VS Code** (alternative) → https://code.visualstudio.com
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
- [ ] Download installer
|
||||||
|
- [ ] **Windows:** Run `.exe`, click through
|
||||||
|
- [ ] **Mac:** Drag to Applications, open
|
||||||
|
- [ ] **Linux:** Follow distro instructions
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## First Launch
|
||||||
|
|
||||||
|
- [ ] Choose theme (Light/Dark)
|
||||||
|
- [ ] **Sign in with GitHub** → Yes!
|
||||||
|
- [ ] Install recommended extensions → Yes
|
||||||
|
- [ ] ✅ IDE open
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Verify Terminal
|
||||||
|
|
||||||
|
- [ ] Press **Ctrl+`** (Win/Linux) or **Cmd+`** (Mac)
|
||||||
|
- [ ] ✅ Terminal panel appears
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Step
|
||||||
|
|
||||||
|
✅ IDE installed!
|
||||||
|
|
||||||
|
**[→ Lesson 03: Git Configuration](../lesson-03-git-setup/checklist.md)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Need more detail?** See [full lesson explanation](lesson.md)
|
||||||
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# Lesson 03: Git Configuration - Quick Checklist
|
||||||
|
|
||||||
|
**⏱️ 5 minutes**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Choose Approach
|
||||||
|
|
||||||
|
- [ ] **Option 1:** Let Cursor handle Git (easiest - do nothing now!)
|
||||||
|
- [ ] **Option 2:** Use GitHub Desktop (visual) → https://desktop.github.com
|
||||||
|
- [ ] **Option 3:** Check terminal: `git --version`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## If Using GitHub Desktop
|
||||||
|
|
||||||
|
- [ ] Download from https://desktop.github.com
|
||||||
|
- [ ] Install
|
||||||
|
- [ ] Sign in with GitHub account
|
||||||
|
- [ ] ✅ Ready to clone visually
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recap Your Repo Structure
|
||||||
|
|
||||||
|
You decided in Lesson 01:
|
||||||
|
- [ ] Single repo: `my-project` (specs + code together)
|
||||||
|
- [ ] Separate repo: `my-project-specs` (specs only)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Step
|
||||||
|
|
||||||
|
✅ Git configured!
|
||||||
|
|
||||||
|
**[→ Lesson 04: Repository Cloning & WDS Integration](../lesson-04-clone-and-wds/checklist.md)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Need more detail?** See [full lesson explanation](lesson.md)
|
||||||
|
|
||||||
|
|
@ -0,0 +1,93 @@
|
||||||
|
# Lesson 04: Repository Cloning & WDS Integration - Quick Checklist
|
||||||
|
|
||||||
|
**⏱️ 15-20 minutes**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Create Projects Folder
|
||||||
|
|
||||||
|
In Cursor terminal (**Ctrl+`** or **Cmd+`**):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Windows
|
||||||
|
mkdir C:\Projects
|
||||||
|
cd C:\Projects
|
||||||
|
|
||||||
|
# Mac/Linux
|
||||||
|
mkdir ~/Projects
|
||||||
|
cd ~/Projects
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] ✅ Projects folder created
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Clone Your Project
|
||||||
|
|
||||||
|
- [ ] Go to your repo on GitHub → Click **"Code"** → Copy URL
|
||||||
|
- [ ] In terminal: `git clone [paste-url-here]`
|
||||||
|
- [ ] (If prompted: Install Git → Click "Install")
|
||||||
|
- [ ] ✅ "done" message
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Open Project in Cursor
|
||||||
|
|
||||||
|
- [ ] **File** → **Open Folder**
|
||||||
|
- [ ] Select your project folder
|
||||||
|
- [ ] ✅ Project in sidebar
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Clone WDS
|
||||||
|
|
||||||
|
In terminal:
|
||||||
|
```bash
|
||||||
|
cd ~/Projects # or cd C:\Projects
|
||||||
|
git clone https://github.com/whiteport-collective/whiteport-design-studio.git
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] ✅ WDS cloned
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Add WDS to Workspace
|
||||||
|
|
||||||
|
- [ ] **File** → **Add Folder to Workspace**
|
||||||
|
- [ ] Select `whiteport-design-studio` folder
|
||||||
|
- [ ] Click **"Add"**
|
||||||
|
- [ ] ✅ Both folders in sidebar
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Create Docs Structure
|
||||||
|
|
||||||
|
In terminal (in YOUR project folder):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd ~/Projects/your-project-name # YOUR project!
|
||||||
|
|
||||||
|
# Mac/Linux
|
||||||
|
mkdir -p docs/{1-project-brief,2-trigger-mapping,3-prd-platform,4-ux-design,5-design-system,6-design-deliveries,7-testing,8-ongoing-development}
|
||||||
|
|
||||||
|
# Windows (if above doesn't work)
|
||||||
|
mkdir docs
|
||||||
|
cd docs
|
||||||
|
mkdir 1-project-brief 2-trigger-mapping 3-prd-platform 4-ux-design 5-design-system 6-design-deliveries 7-testing 8-ongoing-development
|
||||||
|
cd ..
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] ✅ 8 folders in `docs/`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Step
|
||||||
|
|
||||||
|
✅ Everything cloned and ready!
|
||||||
|
|
||||||
|
**[→ Lesson 05: Mimir Activation](../lesson-05-initiate-mimir/checklist.md)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Need more detail?** See [full lesson explanation](lesson.md)
|
||||||
|
|
||||||
|
|
@ -0,0 +1,79 @@
|
||||||
|
# Lesson 05: Mimir Activation - Quick Checklist
|
||||||
|
|
||||||
|
**⏱️ 5 minutes**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Find Mimir
|
||||||
|
|
||||||
|
In Cursor sidebar:
|
||||||
|
- [ ] Expand `whiteport-design-studio`
|
||||||
|
- [ ] Expand `src` → `modules` → `wds`
|
||||||
|
- [ ] Find `MIMIR-WDS-ORCHESTRATOR.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Open AI Chat
|
||||||
|
|
||||||
|
- [ ] Press **Ctrl+L** (Win/Linux) or **Cmd+L** (Mac)
|
||||||
|
- [ ] Or click chat icon in sidebar
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Activate Mimir
|
||||||
|
|
||||||
|
- [ ] Drag `MIMIR-WDS-ORCHESTRATOR.md` into chat input
|
||||||
|
- [ ] OR type: `@MIMIR-WDS-ORCHESTRATOR.md`
|
||||||
|
- [ ] Type: "Hello Mimir! I just completed setup and I'm ready to start."
|
||||||
|
- [ ] Press **Enter**
|
||||||
|
- [ ] ✅ Mimir responds!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Answer Mimir's Questions
|
||||||
|
|
||||||
|
Be honest about:
|
||||||
|
- [ ] Your skill level (beginner/learning/comfortable/experienced)
|
||||||
|
- [ ] Your project
|
||||||
|
- [ ] How you're feeling
|
||||||
|
|
||||||
|
Mimir will:
|
||||||
|
- [ ] Verify your installation
|
||||||
|
- [ ] Guide your next steps
|
||||||
|
- [ ] Connect you with specialist agents when ready
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Remember This Command
|
||||||
|
|
||||||
|
Whenever you need help:
|
||||||
|
```
|
||||||
|
@wds-mimir [your question]
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎉 You Did It!
|
||||||
|
|
||||||
|
**Completed:**
|
||||||
|
- ✅ GitHub account & repository
|
||||||
|
- ✅ IDE installed
|
||||||
|
- ✅ Project cloned
|
||||||
|
- ✅ WDS integrated
|
||||||
|
- ✅ Docs structure created
|
||||||
|
- ✅ Mimir activated
|
||||||
|
|
||||||
|
**You're ready to design with WDS!**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
- **[Module 03: Create Project Brief](../../module-03-project-brief/module-03-overview.md)**
|
||||||
|
- **[WDS Training Course](../../00-course-overview.md)**
|
||||||
|
- **Ask Mimir:** "What should I do next?"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Need more detail?** See [full lesson explanation](lesson.md)
|
||||||
|
|
||||||
|
|
@ -16,46 +16,65 @@ This module takes you from having nothing to being fully set up with WDS, even i
|
||||||
|
|
||||||
## Lessons
|
## Lessons
|
||||||
|
|
||||||
### [Lesson 01: GitHub Setup](lesson-01-setting-up-github/tutorial.md)
|
### [Lesson 01: GitHub Setup](lesson-01-setting-up-github/)
|
||||||
**15-20 minutes**
|
**15-20 minutes**
|
||||||
|
|
||||||
Create GitHub account, choose username, create or join repository. Learn single vs separate repo structure.
|
Create GitHub account, choose username, create or join repository.
|
||||||
|
|
||||||
|
- **[Quick Checklist](lesson-01-setting-up-github/checklist.md)** - Just the steps
|
||||||
|
- **[Full Lesson](lesson-01-setting-up-github/lesson.md)** - Detailed explanation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### [Lesson 02: IDE Installation](lesson-02-install-ide/tutorial.md)
|
### [Lesson 02: IDE Installation](lesson-02-install-ide/)
|
||||||
**10 minutes**
|
**10 minutes**
|
||||||
|
|
||||||
Install Cursor or VS Code and do first-launch setup.
|
Install Cursor or VS Code and do first-launch setup.
|
||||||
|
|
||||||
|
- **[Quick Checklist](lesson-02-install-ide/checklist.md)** - Just the steps
|
||||||
|
- **[Full Lesson](lesson-02-install-ide/lesson.md)** - Detailed explanation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### [Lesson 03: Git Configuration](lesson-03-git-setup/tutorial.md)
|
### [Lesson 03: Git Configuration](lesson-03-git-setup/)
|
||||||
**5 minutes**
|
**5 minutes**
|
||||||
|
|
||||||
Let your IDE handle Git automatically or use GitHub Desktop.
|
Let your IDE handle Git automatically or use GitHub Desktop.
|
||||||
|
|
||||||
|
- **[Quick Checklist](lesson-03-git-setup/checklist.md)** - Just the steps
|
||||||
|
- **[Full Lesson](lesson-03-git-setup/lesson.md)** - Detailed explanation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### [Lesson 04: Repository Cloning & WDS Integration](lesson-04-clone-and-wds/tutorial.md)
|
### [Lesson 04: Repository Cloning & WDS Integration](lesson-04-clone-and-wds/)
|
||||||
**15-20 minutes**
|
**15-20 minutes**
|
||||||
|
|
||||||
Clone your repository, add WDS to workspace, create docs structure.
|
Clone your repository, add WDS to workspace, create docs structure.
|
||||||
|
|
||||||
|
- **[Quick Checklist](lesson-04-clone-and-wds/checklist.md)** - Just the steps
|
||||||
|
- **[Full Lesson](lesson-04-clone-and-wds/lesson.md)** - Detailed explanation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### [Lesson 05: Mimir Activation](lesson-05-initiate-mimir/tutorial.md)
|
### [Lesson 05: Mimir Activation](lesson-05-initiate-mimir/)
|
||||||
**5 minutes**
|
**5 minutes**
|
||||||
|
|
||||||
Drag Mimir file to AI chat and begin your guided journey.
|
Drag Mimir file to AI chat and begin your guided journey.
|
||||||
|
|
||||||
|
- **[Quick Checklist](lesson-05-initiate-mimir/checklist.md)** - Just the steps
|
||||||
|
- **[Full Lesson](lesson-05-initiate-mimir/lesson.md)** - Detailed explanation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
**Want to dive right in?**
|
**Want the fastest path?**
|
||||||
|
|
||||||
Follow lessons in order: [Start with Lesson 01 →](lesson-01-setting-up-github/tutorial.md)
|
Follow the checklists in order: [Start with Lesson 01 Checklist →](lesson-01-setting-up-github/checklist.md)
|
||||||
|
|
||||||
|
**Want detailed explanations?**
|
||||||
|
|
||||||
|
Follow the full lessons: [Start with Lesson 01 Full Lesson →](lesson-01-setting-up-github/lesson.md)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue