Skip to content

Commit 93165d2

Browse files
committed
feat: add migration guide and scripts for transitioning to .documentation/ structure
1 parent 1def81c commit 93165d2

7 files changed

Lines changed: 1145 additions & 0 deletions

File tree

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Migration Quick Reference
2+
3+
**Migrating from old Spec Kit structure to .documentation/**
4+
5+
---
6+
7+
## One-Line Migration
8+
9+
### Bash (Linux/Mac/Git Bash)
10+
```bash
11+
curl -sSL https://raw.githubusercontent.com/MarkHazleton/spec-kit/main/.documentation/scripts/migrate-to-documentation.sh | bash
12+
```
13+
14+
### PowerShell (Windows)
15+
```powershell
16+
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/MarkHazleton/spec-kit/main/.documentation/scripts/migrate-to-documentation.ps1'))
17+
```
18+
19+
---
20+
21+
## What Gets Migrated
22+
23+
| Old Location | New Location |
24+
|--------------|--------------|
25+
| `.specify/` | `.documentation/` |
26+
| `memory/` | `.documentation/memory/` |
27+
| `scripts/` | `.documentation/scripts/` |
28+
| `templates/` | `.documentation/templates/` |
29+
| `specs/` | `specs/` (unchanged) |
30+
31+
---
32+
33+
## Manual Migration (If Scripts Fail)
34+
35+
### 1. Create Structure
36+
```bash
37+
mkdir -p .documentation/{memory,scripts,templates}
38+
```
39+
40+
### 2. Move Files
41+
```bash
42+
# If you have .specify/
43+
cp -r .specify/* .documentation/ && mv .specify .specify.old
44+
45+
# If you have root-level directories
46+
cp -r memory/* .documentation/memory/ && mv memory memory.old
47+
cp -r scripts/* .documentation/scripts/ && mv scripts scripts.old
48+
cp -r templates/* .documentation/templates/ && mv templates templates.old
49+
```
50+
51+
### 3. Find & Replace
52+
Search and replace in all files:
53+
- `.specify/``.documentation/`
54+
- `/memory/``/.documentation/memory/`
55+
- `/scripts/``/.documentation/scripts/`
56+
- `/templates/``/.documentation/templates/`
57+
58+
### 4. Update These Files
59+
- [ ] `.claude/commands/*.md`
60+
- [ ] `.github/agents/*.md` (or `.github/prompts/*.md`)
61+
- [ ] `.cursor/commands/*.md`
62+
- [ ] `.documentation/scripts/**/*`
63+
- [ ] `README.md`
64+
- [ ] `.vscode/settings.json`
65+
66+
### 5. Commit
67+
```bash
68+
git add -A
69+
git commit -m "chore: migrate to .documentation/ structure"
70+
```
71+
72+
---
73+
74+
## Verification Checklist
75+
76+
After migration, check:
77+
78+
- [ ] `.documentation/memory/constitution.md` exists
79+
- [ ] `.documentation/scripts/bash/` has scripts
80+
- [ ] `.documentation/templates/` has templates
81+
- [ ] `specs/` directory untouched
82+
- [ ] Slash commands work
83+
- [ ] No references to old paths in command files
84+
- [ ] Scripts execute without errors
85+
86+
---
87+
88+
## Troubleshooting
89+
90+
### Slash Commands Not Working
91+
1. Restart IDE completely
92+
2. Check command files updated:
93+
```bash
94+
grep -r "\.specify" .claude/ # Should return nothing
95+
```
96+
97+
### Script Errors
98+
```bash
99+
# Re-run with verbose output (bash)
100+
bash -x .documentation/scripts/migrate-to-documentation.sh
101+
```
102+
103+
### Manual Path Updates
104+
```bash
105+
# Find all references to old paths
106+
grep -r "\.specify" .
107+
grep -r "/memory/" .
108+
grep -r "/scripts/" .
109+
grep -r "/templates/" .
110+
```
111+
112+
---
113+
114+
## Full Documentation
115+
116+
For detailed guide see: [.documentation/migration-guide.md](.documentation/migration-guide.md)
117+
118+
---
119+
120+
*Quick reference for Spec Kit v1.0.0+ migration*

.documentation/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ specify init --here --ai claude
8484
- [Installation Guide](installation.md) - Detailed setup for all scenarios
8585
- [Quick Start Guide](quickstart.md) - 6-step process walkthrough
8686
- [Upgrade Guide](upgrade.md) - Updating to latest version
87+
- [Migration Guide](migration-guide.md) - Migrate from old `.specify/` structure
8788
- [Local Development](local-development.md) - Contributing to Spec Kit
8889

8990
---

0 commit comments

Comments
 (0)